Re-build docs & commit only updated pages to cover typos

sadielbartholomew · sadielbartholomew · commit 3e3ad11daacf · 2025-10-29T20:30:20.000Z
diff --git a/docs/analysis.html b/docs/analysis.html
@@ -6,13 +6,13 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>Analysis &#8212; Documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b3523f8e" />
-    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=541523b4" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=61cd365c" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=a5d0ad34" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=ca3c1c84" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=e5fbc548" />
+    <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
+    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
+    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
     <link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
     <link rel="stylesheet" type="text/css" href="_static/customise-alabaster.css?v=5dec66a6" />
     <script src="_static/documentation_options.js?v=5318ce95"></script>
@@ -28,16 +28,17 @@
    
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
   
+
+  
   
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head><body>
   <div class="document">
     
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
             <p class="logo"><a href="index.html">
-              <img class="logo" src="_static/logo.svg" alt="Logo of Python cf package"/>
+              <img class="logo" src="_static/logo.svg" alt="Logo"/>
             </a></p>
 
 
@@ -124,7 +125,7 @@ <h3>Related Topics</h3>
 <hr class="docutils" />
 <p>Version 3.18.2 for version 1.12 of the CF conventions.</p>
 <p>All of the Python code in this tutorial is available in an executable
-script (<a class="reference download internal" download="" href="_downloads/f005a212533d023d9ca8ee5ecd9a9065/field_analysis.py"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>, 8kB).</p>
+script (<a class="reference download internal" download="" href="_downloads/field_analysis.py"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>, 8kB).</p>
 <p>Note that this page is duplicated in the <a class="reference internal" href="tutorial.html#tutorial"><span class="std std-ref">tutorial</span></a>.</p>
 <nav class="contents local" id="contents">
 <ul class="simple">
@@ -182,7 +183,7 @@ <h3>Related Topics</h3>
 <span id="id2"></span><h2><a class="toc-backref" href="#id83" role="doc-backlink"><strong>Sample datasets</strong></a><a class="headerlink" href="#sample-datasets" title="Link to this heading">¶</a></h2>
 <p>This tutorial uses a number of small sample datasets, all of which can
 be found in the zip file <code class="docutils literal notranslate"><span class="pre">cf_tutorial_files.zip</span></code>
-(<a class="reference download internal" download="" href="_downloads/662a6146f847a4d1c19d523d3f30e1cc/cf_tutorial_files.zip"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>,
+(<a class="reference download internal" download="" href="_downloads/cf_tutorial_files.zip"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>,
 164kB):</p>
 <div class="literal-block-wrapper docutils container" id="id28">
 <div class="code-block-caption"><span class="caption-text"><em>Unpack the sample datasets.</em></span><a class="headerlink" href="#id28" title="Link to this code">¶</a></div>
@@ -2444,7 +2445,7 @@ <h3><a class="toc-backref" href="#id112" role="doc-backlink">Moving windows</a><
 cell sizes (or custom weights) may applied to the calculation.</p>
 <div class="literal-block-wrapper docutils container" id="id79">
 <div class="code-block-caption"><span class="caption-text"><em>Calculate a 3-point weighted mean of the ‘X’ axis. Since
-the the ‘X’ axis is cyclic, the mean wraps by default.</em></span><a class="headerlink" href="#id79" title="Link to this code">¶</a></div>
+the ‘X’ axis is cyclic, the mean wraps by default.</em></span><a class="headerlink" href="#id79" title="Link to this code">¶</a></div>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="p">,</span> <span class="n">t</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s1">&#39;file.nc&#39;</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
 <span class="go">Field: specific_humidity (ncvar%q)</span>
@@ -2517,7 +2518,7 @@ <h3><a class="toc-backref" href="#id113" role="doc-backlink">Convolution filters
 <a class="reference internal" href="method/cf.Field.convolution_filter.html#cf.Field.convolution_filter" title="cf.Field.convolution_filter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">convolution_filter</span></code></a> method of the field construct.</p>
 <div class="literal-block-wrapper docutils container" id="id80">
 <div class="code-block-caption"><span class="caption-text"><em>Calculate a 5-point mean of the ‘X’ axis with a
-non-uniform window function. Since the the ‘X’ axis is
+non-uniform window function. Since the ‘X’ axis is
 cyclic, the convolution wraps by default.</em></span><a class="headerlink" href="#id80" title="Link to this code">¶</a></div>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
 <span class="go">Field: specific_humidity (ncvar%q)</span>
@@ -2746,11 +2747,11 @@ <h3><a class="toc-backref" href="#id118" role="doc-backlink">Curl</a><a class="h
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2025, NCAS | Page built on 2025-10-16.
+      &#169;2025, NCAS | Page built on 2025-10-29.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.4.7</a>
-      &amp; <a href="https://github.com/sphinx-doc/alabaster">Alabaster 0.7.14</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
       
     </div>
 
diff --git a/docs/field_analysis.html b/docs/field_analysis.html
@@ -6,13 +6,13 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>Statistical collapses &#8212; Documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b3523f8e" />
-    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=541523b4" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=61cd365c" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=a5d0ad34" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=ca3c1c84" />
-    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=e5fbc548" />
+    <link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
+    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
+    <link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
     <link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
     <link rel="stylesheet" type="text/css" href="_static/customise-alabaster.css?v=5dec66a6" />
     <script src="_static/documentation_options.js?v=5318ce95"></script>
@@ -28,16 +28,17 @@
    
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
   
+
+  
   
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head><body>
   <div class="document">
     
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
             <p class="logo"><a href="index.html">
-              <img class="logo" src="_static/logo.svg" alt="Logo of Python cf package"/>
+              <img class="logo" src="_static/logo.svg" alt="Logo"/>
             </a></p>
 
 
@@ -2352,7 +2353,7 @@ <h2>Moving windows<a class="headerlink" href="#moving-windows" title="Link to th
 cell sizes (or custom weights) may applied to the calculation.</p>
 <div class="literal-block-wrapper docutils container" id="id76">
 <div class="code-block-caption"><span class="caption-text"><em>Calculate a 3-point weighted mean of the ‘X’ axis. Since
-the the ‘X’ axis is cyclic, the mean wraps by default.</em></span><a class="headerlink" href="#id76" title="Link to this code">¶</a></div>
+the ‘X’ axis is cyclic, the mean wraps by default.</em></span><a class="headerlink" href="#id76" title="Link to this code">¶</a></div>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">q</span><span class="p">,</span> <span class="n">t</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s1">&#39;file.nc&#39;</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
 <span class="go">Field: specific_humidity (ncvar%q)</span>
@@ -2425,7 +2426,7 @@ <h2>Convolution filters<a class="headerlink" href="#convolution-filters" title="
 <a class="reference internal" href="method/cf.Field.convolution_filter.html#cf.Field.convolution_filter" title="cf.Field.convolution_filter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">convolution_filter</span></code></a> method of the field construct.</p>
 <div class="literal-block-wrapper docutils container" id="id77">
 <div class="code-block-caption"><span class="caption-text"><em>Calculate a 5-point mean of the ‘X’ axis with a
-non-uniform window function. Since the the ‘X’ axis is
+non-uniform window function. Since the ‘X’ axis is
 cyclic, the convolution wraps by default.</em></span><a class="headerlink" href="#id77" title="Link to this code">¶</a></div>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
 <span class="go">Field: specific_humidity (ncvar%q)</span>
@@ -2653,11 +2654,11 @@ <h2>Curl<a class="headerlink" href="#curl" title="Link to this heading">¶</a></
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2025, NCAS | Page built on 2025-10-16.
+      &#169;2025, NCAS | Page built on 2025-10-29.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 7.4.7</a>
-      &amp; <a href="https://github.com/sphinx-doc/alabaster">Alabaster 0.7.14</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
       
     </div>
 
diff --git a/docs/introduction.html b/docs/introduction.html
@@ -133,10 +133,11 @@ <h1><strong>Introduction</strong><a class="headerlink" href="#introduction" titl
 <ul class="simple">
 <li><p><a class="reference internal" href="#functionality" id="id5"><strong>Functionality</strong></a></p></li>
 <li><p><a class="reference internal" href="#visualisation" id="id6"><strong>Visualisation</strong></a></p></li>
-<li><p><a class="reference internal" href="#performance" id="id7"><strong>Performance</strong></a></p></li>
-<li><p><a class="reference internal" href="#command-line-utilities" id="id8"><strong>Command line utilities</strong></a></p></li>
-<li><p><a class="reference internal" href="#cf-data-model" id="id9"><strong>CF data model</strong></a></p></li>
-<li><p><a class="reference internal" href="#references" id="id10"><strong>References</strong></a></p></li>
+<li><p><a class="reference internal" href="#training" id="id7"><strong>Training</strong></a></p></li>
+<li><p><a class="reference internal" href="#performance" id="id8"><strong>Performance</strong></a></p></li>
+<li><p><a class="reference internal" href="#command-line-utilities" id="id9"><strong>Command line utilities</strong></a></p></li>
+<li><p><a class="reference internal" href="#cf-data-model" id="id10"><strong>CF data model</strong></a></p></li>
+<li><p><a class="reference internal" href="#references" id="id11"><strong>References</strong></a></p></li>
 </ul>
 </nav>
 <section id="functionality">
@@ -224,15 +225,23 @@ <h2><a class="toc-backref" href="#id6" role="doc-backlink"><strong>Visualisation
 </figure>
 </section>
 <hr class="docutils" />
+<section id="training">
+<h2><a class="toc-backref" href="#id7" role="doc-backlink"><strong>Training</strong></a><a class="headerlink" href="#training" title="Link to this heading">¶</a></h2>
+<p>Training material on cf-python and cf-plot i.e. the CF Data Tools,
+in the form of Jupyter Notebooks, is openly-accessible and available
+(with instructions for set-up provided) at:
+<a class="reference external" href="https://github.com/NCAS-CMS/cf-tools-training">https://github.com/NCAS-CMS/cf-tools-training</a>.</p>
+</section>
+<hr class="docutils" />
 <section id="performance">
-<h2><a class="toc-backref" href="#id7" role="doc-backlink"><strong>Performance</strong></a><a class="headerlink" href="#performance" title="Link to this heading">¶</a></h2>
+<h2><a class="toc-backref" href="#id8" role="doc-backlink"><strong>Performance</strong></a><a class="headerlink" href="#performance" title="Link to this heading">¶</a></h2>
 <p>The <code class="xref py py-obj docutils literal notranslate"><span class="pre">cf</span></code> package uses <a class="reference internal" href="performance.html#performance"><span class="std std-ref">Dask</span></a> for all of its data
 manipulations, which provides lazy, parallelised, and out-of-core
 computations of array operations.</p>
 </section>
 <hr class="docutils" />
 <section id="command-line-utilities">
-<h2><a class="toc-backref" href="#id8" role="doc-backlink"><strong>Command line utilities</strong></a><a class="headerlink" href="#command-line-utilities" title="Link to this heading">¶</a></h2>
+<h2><a class="toc-backref" href="#id9" role="doc-backlink"><strong>Command line utilities</strong></a><a class="headerlink" href="#command-line-utilities" title="Link to this heading">¶</a></h2>
 <p>During installation the <code class="docutils literal notranslate"><span class="pre">cfa</span></code> command line utility is also
 installed, which</p>
 <ul class="simple">
@@ -243,7 +252,7 @@ <h2><a class="toc-backref" href="#id8" role="doc-backlink"><strong>Command line
 <hr class="docutils" />
 </section>
 <section id="cf-data-model">
-<span id="id1"></span><h2><a class="toc-backref" href="#id9" role="doc-backlink"><strong>CF data model</strong></a><a class="headerlink" href="#cf-data-model" title="Link to this heading">¶</a></h2>
+<span id="id1"></span><h2><a class="toc-backref" href="#id10" role="doc-backlink"><strong>CF data model</strong></a><a class="headerlink" href="#cf-data-model" title="Link to this heading">¶</a></h2>
 <p>The CF (Climate and Forecast) metadata conventions
 (<a class="reference external" href="http://cfconventions.org">http://cfconventions.org</a>) provide a description of the physical
 meaning of data and of their spatial and temporal properties and are
@@ -314,13 +323,13 @@ <h2><a class="toc-backref" href="#id8" role="doc-backlink"><strong>Command line
 </div>
 <figure class="align-default" id="id4">
 <img alt="_images/cfdm_field.svg" src="_images/cfdm_field.svg" /><figcaption>
-<p><span class="caption-text"><em>The constructs of the CF data model described using UML. The field construct corresponds to a CF-netCDF data variable. The domain construct provides the linkage between the field construct and the constructs which describe measurement locations and cell properties. It is useful to define an abstract generic coordinate construct that can be used to refer to coordinates when the their type (dimension or auxiliary coordinate construct) is not an issue.</em></span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
+<p><span class="caption-text"><em>The constructs of the CF data model described using UML. The field construct corresponds to a CF-netCDF data variable. The domain construct provides the linkage between the field construct and the constructs which describe measurement locations and cell properties. It is useful to define an abstract generic coordinate construct that can be used to refer to coordinates when their type (dimension or auxiliary coordinate construct) is not an issue.</em></span><a class="headerlink" href="#id4" title="Link to this image">¶</a></p>
 </figcaption>
 </figure>
 </section>
 <hr class="docutils" />
 <section id="references">
-<h2><a class="toc-backref" href="#id10" role="doc-backlink"><strong>References</strong></a><a class="headerlink" href="#references" title="Link to this heading">¶</a></h2>
+<h2><a class="toc-backref" href="#id11" role="doc-backlink"><strong>References</strong></a><a class="headerlink" href="#references" title="Link to this heading">¶</a></h2>
 <dl class="simple">
 <dt>Eaton, B., Gregory, J., Drach, B., Taylor, K., Hankin, S., Caron, J.,</dt><dd><p>Signell, R., et al. NetCDF Climate and Forecast (CF) Metadata
 Conventions. CF Conventions Committee.
@@ -355,7 +364,7 @@ <h2><a class="toc-backref" href="#id10" role="doc-backlink"><strong>References</
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &#169;2025, NCAS | Page built on 2025-10-22.
+      &#169;2025, NCAS | Page built on 2025-10-29.
       
       |
       Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
diff --git a/docs/tutorial.html b/docs/tutorial.html
