Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add link to auth page on rc files. #1353

Merged
merged 3 commits into from
Jul 31, 2024
Merged

[docs] Add link to auth page on rc files. #1353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f7b87f5
[docs] Add link to auth page on rc files. Incidentally pdoc re-insert…
RandallPittmanOrSt Jul 25, 2024
3a6d944
(minor) simplify diff
RandallPittmanOrSt Jul 25, 2024
9996c01
Correct auth link
RandallPittmanOrSt Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1173,7 +1173,8 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<span>def <span class="ident">date2index</span></span>(<span>dates, nctime, calendar=None, select='exact', has_year_zero=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Return indices of a netCDF time variable corresponding to the given dates.</p>
<div class="desc"><p>date2index(dates, nctime, calendar=None, select=u'exact', has_year_zero=None)</p>
<p>Return indices of a netCDF time variable corresponding to the given dates.</p>
<p><strong>dates</strong>: A datetime object or a sequence of datetime objects.
The datetime objects should not include a time-zone offset.</p>
<p><strong>nctime</strong>: A netCDF time variable object. The nctime object must have a
Expand Down Expand Up @@ -1212,7 +1213,8 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<span>def <span class="ident">date2num</span></span>(<span>dates, units, calendar=None, has_year_zero=None, longdouble=False)</span>
</code></dt>
<dd>
<div class="desc"><p>Return numeric time values given datetime objects. The units
<div class="desc"><p>date2num(dates, units, calendar=None, has_year_zero=None, longdouble=False)</p>
<p>Return numeric time values given datetime objects. The units
of the numeric time values are described by the <strong>units</strong> argument
and the <strong>calendar</strong> keyword. The datetime objects must
be in UTC with no time-zone offset.
Expand Down Expand Up @@ -1292,7 +1294,8 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<span>def <span class="ident">num2date</span></span>(<span>times, units, calendar='standard', only_use_cftime_datetimes=True, only_use_python_datetimes=False, has_year_zero=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Return datetime objects given numeric time values. The units
<div class="desc"><p>num2date(times, units, calendar=u'standard', only_use_cftime_datetimes=True, only_use_python_datetimes=False, has_year_zero=None)</p>
<p>Return datetime objects given numeric time values. The units
of the numeric time values are described by the <strong>units</strong> argument
and the <strong>calendar</strong> keyword. The returned datetime objects represent
UTC with no time-zone offset, even if the specified
Expand Down Expand Up @@ -1348,14 +1351,18 @@ <h2 class="section-title" id="header-functions">Functions</h2>
</code></dt>
<dd>
<div class="desc"><p><strong><code>rc_get(key)</code></strong></p>
<p>Returns the internal netcdf-c rc table value corresponding to key.</p></div>
<p>Returns the internal netcdf-c rc table value corresponding to key.
See <a href="https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html">https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html</a>
for more information on rc files and values.</p></div>
</dd>
<dt id="netCDF4.rc_set"><code class="name flex">
<span>def <span class="ident">rc_set</span></span>(<span>key, value)</span>
</code></dt>
<dd>
<div class="desc"><p><strong><code>rc_set(key, value)</code></strong></p>
<p>Sets the internal netcdf-c rc table value corresponding to key.</p></div>
<p>Sets the internal netcdf-c rc table value corresponding to key.
See <a href="https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html">https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html</a>
for more information on rc files and values.</p></div>
</dd>
<dt id="netCDF4.set_alignment"><code class="name flex">
<span>def <span class="ident">set_alignment</span></span>(<span>threshold, alignment)</span>
Expand Down
4 changes: 4 additions & 0 deletions src/netCDF4/_netCDF4.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1323,6 +1323,8 @@ def rc_get(key):
**```rc_get(key)```**

Returns the internal netcdf-c rc table value corresponding to key.
See <https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html>
for more information on rc files and values.
"""
cdef int ierr
cdef char *keyc
Expand All @@ -1345,6 +1347,8 @@ def rc_set(key, value):
**```rc_set(key, value)```**

Sets the internal netcdf-c rc table value corresponding to key.
See <https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html>
for more information on rc files and values.
"""
cdef int ierr
cdef char *keyc
Expand Down
Loading