Skip to content

Commit 234e1e7

Browse files
sadielbartholomewsadielbartholomew
committed
v3.18.2 documentation
1 parent d88e9a0 commit 234e1e7

4,724 files changed

Lines changed: 75685 additions & 81251 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/2_to_3_changes.html‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<title>Incompatible differences between versions 2.x and 3.x &#8212; Documentation</title>
9-
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
10-
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=a5d0ad34" />
11-
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
9+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b3523f8e" />
10+
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=541523b4" />
11+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
1212
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
13-
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
14-
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
15-
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
13+
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
14+
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=ca3c1c84" />
15+
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=e5fbc548" />
1616
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
1717
<link rel="stylesheet" type="text/css" href="_static/customise-alabaster.css?v=5dec66a6" />
18-
<script src="_static/documentation_options.js?v=64e044ff"></script>
19-
<script src="_static/doctools.js?v=9bcbadda"></script>
18+
<script src="_static/documentation_options.js?v=5318ce95"></script>
19+
<script src="_static/doctools.js?v=9a2dae69"></script>
2020
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
2121
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
2222
<script src="_static/copybutton.js?v=b578dfe4"></script>
@@ -27,9 +27,8 @@
2727

2828
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
2929

30-
31-
3230

31+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
3332

3433
</head><body>
3534
<div class="document">
@@ -42,7 +41,7 @@
4241

4342

4443

45-
<h1 class="logo"><a href="index.html">cf 3.18.1</a></h1>
44+
<h1 class="logo"><a href="index.html">cf 3.18.2</a></h1>
4645

4746

4847

@@ -138,7 +137,7 @@ <h2>Python<a class="headerlink" href="#python" title="Link to this heading">¶</
138137
</section>
139138
<section id="in-place-operations">
140139
<h2>In-place operations<a class="headerlink" href="#in-place-operations" title="Link to this heading"></a></h2>
141-
<p>At version 3.x, in-place operations return <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>, rather than the
140+
<p>At version 3.x, in-place operations return <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>, rather than the
142141
modified construct. The keyword that defines the operation to be
143142
in-place is now <em>inplace</em> (rather than <em>i</em>).</p>
144143
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">g</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">tranpose</span><span class="p">()</span>
@@ -479,11 +478,11 @@ <h2>Changes to the API of existing methods<a class="headerlink" href="#changes-
479478
<div class="clearer"></div>
480479
</div>
481480
<div class="footer">
482-
&#169;2025, NCAS | Page built on 2025-08-20.
481+
&copy;2025, NCAS | Page built on 2025-10-16.
483482

484483
|
485-
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
486-
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
484+
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.4.7</a>
485+
&amp; <a href="https://github.com/sphinx-doc/alabaster">Alabaster 0.7.14</a>
487486

488487
</div>
489488

‎docs/Changelog.html‎

Lines changed: 278 additions & 265 deletions
Large diffs are not rendered by default.

‎docs/_sources/installation.rst.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Windows Subsystem for Linux (WSL)
3232
**Python versions**
3333
-------------------
3434

35-
The cf package is only for Python 3.9 or newer.
35+
The cf package is only for Python 3.10 or newer.
3636

3737
----
3838

@@ -209,7 +209,7 @@ installed, which:
209209
Required
210210
^^^^^^^^
211211

212-
* `Python <https://www.python.org/>`_, 3.9.0 or newer.
212+
* `Python <https://www.python.org/>`_, 3.10.0 or newer.
213213

214214
* `numpy <http://www.numpy.org>`_, versions 2.0.0 or newer.
215215

@@ -218,14 +218,14 @@ Required
218218
* `distributed <https://pypi.org/project/distributed>`_, version 2025.5.1 or
219219
newer.
220220

221-
* `netCDF4 <https://pypi.org/project/netcdf4/>`_, 1.7.2 or newer.
221+
* `netCDF4 <https://pypi.org/project/netcdf4/>`_, version 1.7.2 only.
222222

223223
* `cftime <https://pypi.org/project/cftime/>`_, version 1.6.4 or newer
224224
(note that this package may be installed with netCDF4).
225225

226226
* `scipy <https://pypi.org/project/scipy>`_, version 1.10.0 or newer.
227227

228-
* `cfdm <https://pypi.org/project/cfdm/>`_, version 1.12.3.0 or up to,
228+
* `cfdm <https://pypi.org/project/cfdm/>`_, version 1.12.3.1 or up to,
229229
but not including, 1.12.4.0.
230230

231231
* `cfunits <https://pypi.org/project/cfunits/>`_, version 3.3.7 or newer.

‎docs/_sources/introduction.rst.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ The `cf` package can:
114114
* regrid structured grid, mesh and DSG field constructs with
115115
(multi-)linear, nearest neighbour, first- and second-order
116116
conservative and higher order patch recovery methods, including
117-
3-d regridding,
117+
3-d regridding, and large-grid support,
118118

119119
* apply convolution filters to field constructs,
120120

@@ -124,7 +124,7 @@ The `cf` package can:
124124

125125
* create derived quantities (such as relative vorticity),
126126

127-
* read and write that data that are quantized to eliminate false
127+
* read and write data that are quantized to eliminate false
128128
precision.
129129

130130
----

‎docs/_sources/releases.rst.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Documentation for all versions of cf.
1616
**CF-1.12**
1717
-----------
1818

19+
* `Version 3.18.2 <https://ncas-cms.github.io/cf-python-docs/3.18.1>`_ (2025-10-16)
1920
* `Version 3.18.1 <https://ncas-cms.github.io/cf-python-docs/3.18.1>`_ (2025-08-20)
2021
* `Version 3.18.0 <https://ncas-cms.github.io/cf-python-docs/3.18.0>`_ (2025-06-05)
2122
* `Version 3.17.0 <https://ncas-cms.github.io/cf-python-docs/3.17.0>`_ (2025-04-02)

‎docs/_static/alabaster.css‎

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,6 @@ div.relations {
6969
}
7070

7171

72-
div.sphinxsidebar {
73-
max-height: 100%;
74-
overflow-y: auto;
75-
}
76-
7772
div.sphinxsidebar a {
7873
color: #444;
7974
text-decoration: none;
@@ -160,14 +155,6 @@ div.sphinxsidebar input {
160155
font-size: 1em;
161156
}
162157

163-
div.sphinxsidebar #searchbox input[type="text"] {
164-
width: 160px;
165-
}
166-
167-
div.sphinxsidebar .search > div {
168-
display: table-cell;
169-
}
170-
171158
div.sphinxsidebar hr {
172159
border: none;
173160
height: 1px;
@@ -657,7 +644,7 @@ a:hover tt, a:hover code {
657644
display: none!important;
658645
}
659646

660-
/* Hide ugly table cell borders in ..bibliography:: directive output */
647+
/* Hide fugly table cell borders in ..bibliography:: directive output */
661648
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
662649
border: none;
663650
/* Below needed in some edge cases; if not applied, bottom shadows appear */

‎docs/_static/basic.css‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
/*
2+
* basic.css
3+
* ~~~~~~~~~
4+
*
25
* Sphinx stylesheet -- basic theme.
6+
*
7+
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8+
* :license: BSD, see LICENSE for details.
9+
*
310
*/
411

512
/* -- main layout ----------------------------------------------------------- */
@@ -108,11 +115,15 @@ img {
108115
/* -- search page ----------------------------------------------------------- */
109116

110117
ul.search {
111-
margin-top: 10px;
118+
margin: 10px 0 0 20px;
119+
padding: 0;
112120
}
113121

114122
ul.search li {
115-
padding: 5px 0;
123+
padding: 5px 0 5px 20px;
124+
background-image: url(file.png);
125+
background-repeat: no-repeat;
126+
background-position: 0 7px;
116127
}
117128

118129
ul.search li a {
@@ -741,6 +752,14 @@ abbr, acronym {
741752
cursor: help;
742753
}
743754

755+
.translated {
756+
background-color: rgba(207, 255, 207, 0.2)
757+
}
758+
759+
.untranslated {
760+
background-color: rgba(255, 207, 207, 0.2)
761+
}
762+
744763
/* -- code displays --------------------------------------------------------- */
745764

746765
pre {

‎docs/_static/doctools.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
/*
2+
* doctools.js
3+
* ~~~~~~~~~~~
4+
*
25
* Base JavaScript utilities for all Sphinx HTML documentation.
6+
*
7+
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8+
* :license: BSD, see LICENSE for details.
9+
*
310
*/
411
"use strict";
512

‎docs/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '3.18.1',
2+
VERSION: '3.18.2',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

‎docs/_static/graphviz.css‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
/*
2+
* graphviz.css
3+
* ~~~~~~~~~~~~
4+
*
25
* Sphinx stylesheet -- graphviz extension.
6+
*
7+
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8+
* :license: BSD, see LICENSE for details.
9+
*
310
*/
411

512
img.graphviz {

0 commit comments

Comments
 (0)