Skip to content

Commit cc4d7df

Browse files
committed
v3.13.1 latest documentation
1 parent 3af4dae commit cc4d7df

File tree

3,480 files changed

+10177
-10151
lines changed

Some content is hidden

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

3,480 files changed

+10177
-10151
lines changed

docs/2_to_3_changes.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737

3838

39-
<h1 class="logo"><a href="index.html">cf 3.13.0</a></h1>
39+
<h1 class="logo"><a href="index.html">cf 3.13.1</a></h1>
4040

4141

4242

@@ -263,7 +263,7 @@ <h2>Changes to the API of existing methods<a class="headerlink" href="#changes-
263263
<td><p>No <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> parameters. Construct identity arguments
264264
are no longer assumed to be an abbreviation.</p></td>
265265
</tr>
266-
<tr class="row-odd"><td><p><a class="reference internal" href="attribute/cf.Field.axes.html#cf.Field.axes" title="cf.Field.axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.Field.axes</span></code></a></p></td>
266+
<tr class="row-odd"><td><p><a class="reference internal" href="method/cf.Field.axes.html#cf.Field.axes" title="cf.Field.axes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.Field.axes</span></code></a></p></td>
267267
<td><p>No <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> parameters. Construct identity arguments
268268
are no longer assumed to be an abbreviation.</p></td>
269269
</tr>
@@ -481,7 +481,7 @@ <h2>Changes to the API of existing methods<a class="headerlink" href="#changes-
481481
<div class="clearer"></div>
482482
</div>
483483
<div class="footer">
484-
&copy;2022, NCAS | Page built on 2022-06-23.
484+
&copy;2022, NCAS | Page built on 2022-10-17.
485485

486486
|
487487
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

docs/Changelog.html

Lines changed: 228 additions & 209 deletions
Large diffs are not rendered by default.
0 Bytes
Binary file not shown.

docs/_sources/installation.rst.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ To install from source:
119119
1. Download the cf package from https://pypi.org/project/cf-python
120120

121121
2. Unpack the library (replacing ``<version>`` with the version that
122-
you want to install, e.g. ``3.9.0``):
122+
you want to install, e.g. ``3.13.1``):
123123

124124
.. code-block:: console
125125
@@ -180,8 +180,7 @@ installed, which
180180
Required
181181
^^^^^^^^
182182

183-
* `Python <https://www.python.org/>`_, 3.7 or newer, including
184-
the latest version Python 3.9.
183+
* `Python <https://www.python.org/>`_, 3.7 or newer,
185184

186185
* `numpy <https://pypi.org/project/numpy/>`_, 1.15 or newer.
187186

@@ -190,7 +189,7 @@ Required
190189
* `cftime <https://pypi.org/project/cftime/>`_, version 1.5.0 or newer
191190
(note that this package may be installed with netCDF4).
192191

193-
* `cfdm <https://pypi.org/project/cfdm/>`_, version 1.9.0.3 or up to,
192+
* `cfdm <https://pypi.org/project/cfdm/>`_, version 1.9.0.4 or up to,
194193
but not including, 1.9.1.0.
195194

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

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.9**
1717
----------
1818

19+
* `Version 3.13.1 <https://ncas-cms.github.io/cf-python/3.13.1>`_ (2022-10-17)
1920
* `Version 3.13.0 <https://ncas-cms.github.io/cf-python/3.13.0>`_ (2022-06-23)
2021
* `Version 3.12.0 <https://ncas-cms.github.io/cf-python/3.12.0>`_ (2022-01-18)
2122
* `Version 3.11.0 <https://ncas-cms.github.io/cf-python/3.11.0>`_ (2021-10-08)

docs/_static/copy-button.svg

Lines changed: 3 additions & 3 deletions
Loading

docs/_static/copybutton.css

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ button.copybtn {
33
position: absolute;
44
display: flex;
55
top: .3em;
6-
right: .5em;
6+
right: .3em;
77
width: 1.7em;
88
height: 1.7em;
99
opacity: 0;
@@ -13,17 +13,22 @@ button.copybtn {
1313
border: none;
1414
outline: none;
1515
border-radius: 0.4em;
16-
border: #e1e1e1 1px solid;
17-
background-color: rgb(245, 245, 245);
16+
/* The colors that GitHub uses */
17+
border: #1b1f2426 1px solid;
18+
background-color: #f6f8fa;
19+
color: #57606a;
1820
}
1921

2022
button.copybtn.success {
2123
border-color: #22863a;
24+
color: #22863a;
2225
}
2326

24-
button.copybtn img {
25-
width: 100%;
26-
padding: .2em;
27+
button.copybtn svg {
28+
stroke: currentColor;
29+
width: 1.5em;
30+
height: 1.5em;
31+
padding: 0.1em;
2732
}
2833

2934
div.highlight {
@@ -79,3 +84,10 @@ div.highlight {
7984
transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1);
8085
transition-delay: .5s;
8186
}
87+
88+
/* By default the copy button shouldn't show up when printing a page */
89+
@media print {
90+
button.copybtn {
91+
display: none;
92+
}
93+
}

docs/_static/copybutton.js

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ const messages = {
3535
'copy_to_clipboard': '复制到剪贴板',
3636
'copy_success': '复制成功!',
3737
'copy_failure': '复制失败',
38+
},
39+
'it' : {
40+
'copy': 'Copiare',
41+
'copy_to_clipboard': 'Copiato negli appunti',
42+
'copy_success': 'Copiato!',
43+
'copy_failure': 'Errore durante la copia',
3844
}
3945
}
4046

@@ -49,7 +55,25 @@ if (doc_url_root == '#') {
4955
doc_url_root = '';
5056
}
5157

52-
const path_static = `${doc_url_root}_static/`;
58+
/**
59+
* SVG files for our copy buttons
60+
*/
61+
let iconCheck = `<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-check" width="44" height="44" viewBox="0 0 24 24" stroke-width="2" stroke="#22863a" fill="none" stroke-linecap="round" stroke-linejoin="round">
62+
<title>${messages[locale]['copy_success']}</title>
63+
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
64+
<path d="M5 12l5 5l10 -10" />
65+
</svg>`
66+
67+
// If the user specified their own SVG use that, otherwise use the default
68+
let iconCopy = ``;
69+
if (!iconCopy) {
70+
iconCopy = `<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-copy" width="44" height="44" viewBox="0 0 24 24" stroke-width="1.5" stroke="#000000" fill="none" stroke-linecap="round" stroke-linejoin="round">
71+
<title>${messages[locale]['copy_to_clipboard']}</title>
72+
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
73+
<rect x="8" y="8" width="12" height="12" rx="2" />
74+
<path d="M16 8v-2a2 2 0 0 0 -2 -2h-8a2 2 0 0 0 -2 2v8a2 2 0 0 0 2 2h2" />
75+
</svg>`
76+
}
5377

5478
/**
5579
* Set up copy/paste for code blocks
@@ -88,9 +112,8 @@ const temporarilyChangeTooltip = (el, oldText, newText) => {
88112

89113
// Changes the copy button icon for two seconds, then changes it back
90114
const temporarilyChangeIcon = (el) => {
91-
img = el.querySelector("img");
92-
img.setAttribute('src', `${path_static}check-solid.svg`)
93-
setTimeout(() => img.setAttribute('src', `${path_static}copy-button.svg`), 2000)
115+
el.innerHTML = iconCheck;
116+
setTimeout(() => {el.innerHTML = iconCopy}, 2000)
94117
}
95118

96119
const addCopyButtonToCodeCells = () => {
@@ -109,7 +132,7 @@ const addCopyButtonToCodeCells = () => {
109132

110133
const clipboardButton = id =>
111134
`<button class="copybtn o-tooltip--left" data-tooltip="${messages[locale]['copy']}" data-clipboard-target="#${id}">
112-
<img src="${path_static}copy-button.svg" alt="${messages[locale]['copy_to_clipboard']}">
135+
${iconCopy}
113136
</button>`
114137
codeCell.insertAdjacentHTML('afterend', clipboardButton(id))
115138
})

docs/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '3.13.0',
3+
VERSION: '3.13.1',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

docs/_static/pygments.css

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
pre { line-height: 125%; margin: 0; }
2-
td.linenos pre { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
3-
span.linenos { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
4-
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
5-
span.linenos.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
1+
pre { line-height: 125%; }
2+
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
3+
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
4+
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
5+
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
66
.highlight .hll { background-color: #ffffcc }
77
.highlight { background: #f8f8f8; }
88
.highlight .c { color: #8f5902; font-style: italic } /* Comment */

0 commit comments

Comments
 (0)