Skip to content

Commit a25e018

Browse files
authored
Merge branch 'main' into rajeeja/vector_calc_curl
2 parents 4edf669 + 3fd3681 commit a25e018

File tree

4 files changed

+15
-12
lines changed

4 files changed

+15
-12
lines changed

docs/conf.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,12 @@ def __getattr__(cls, name):
232232
]
233233

234234
# add links to ignore during link checking
235-
linkcheck_ignore = [r"https://gmao.gsfc.nasa.gov/gmaoftp/*"]
235+
linkcheck_ignore = [
236+
r"https://gmao.gsfc.nasa.gov/gmaoftp/*",
237+
r"https://docs.xarray.dev/*",
238+
r"https://seatstandards.org/*",
239+
# More URLs as needed
240+
]
236241

237242

238243
# custom scripts for making a gallery of examples notebooks

docs/contributing.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -608,10 +608,8 @@ As we mentioned a few times throughout this guide, UXarray has a static `documen
608608
repository's code structure. However, there needs to be some manual additions to the
609609
proper documentation index file(s) for the automation to work.
610610

611-
The index files ``docs/user_api/index.rst`` and ``docs/internal_api/index.rst`` (paths
612-
relative from the root directory) are used for UXarray documentation to allow the
613-
`User API <user_api/index.rst>`_ and `Internal API <internal_api/index.rst>`_,
614-
respectively, to be automatically generated.
611+
The index file ``docs/user_api/index.rst`` (path relative from the root directory) is
612+
used for automatically generating the `User API <api.rst>`_ documentation.
615613

616614
That being said, the code changes, which might be a new function implementation or some
617615
modifications to existing ones, must be added to the appropriate ``index.rst``
@@ -625,8 +623,8 @@ file so that its documentation page is automatically generated.
625623
needed. However, it would be a great practice to provide usage examples in the
626624
same PR, especially for demonstrating the use of complex UXarray functions.
627625

628-
The UXarray documentation houses ``examples/<example-name>.ipynb`` files (paths
629-
relative from the root directory) to provide `Usage Examples <examples.rst>`_ to be
626+
The UXarray documentation houses ``docs/examples/<example-name>.ipynb`` files (paths
627+
relative from the root directory) to provide `Usage Examples <gallery.rst>`_ to be
630628
automatically generated. If you prefer to provide usage examples for the work you
631629
have put together, please be sure to put your notebook(s) under this same directory.
632630

docs/user-guide/grid-formats.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ References
162162
----------
163163
* https://easy.gems.dkrz.de/Processing/healpix/index.html#hierarchical-healpix-output
164164
* https://healpix.sourceforge.io/
165-
* https://healpix.jpl.nasa.gov/
165+
* https://irsa.ipac.caltech.edu/healpix/
166166
* https://iopscience.iop.org/article/10.1086/427976
167167

168168
Parsed Variables

uxarray/core/dataarray.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -520,10 +520,10 @@ def zonal_mean(self, lat=(-90, 90, 10), conservative: bool = False, **kwargs):
520520
----------
521521
lat : tuple, float, or array-like, default=(-90, 90, 10)
522522
Latitude specification:
523-
- tuple (start, end, step): For non-conservative, computes means at intervals of `step`.
524-
For conservative, creates band edges via np.arange(start, end+step, step).
525-
- float: Single latitude for non-conservative averaging
526-
- array-like: For non-conservative, latitudes to sample. For conservative, band edges.
523+
- tuple (start, end, step): For non-conservative, computes means at intervals of `step`.
524+
For conservative, creates band edges via np.arange(start, end+step, step).
525+
- float: Single latitude for non-conservative averaging
526+
- array-like: For non-conservative, latitudes to sample. For conservative, band edges.
527527
conservative : bool, default=False
528528
If True, performs conservative (area-weighted) zonal averaging over latitude bands.
529529
If False, performs traditional (non-conservative) averaging at latitude lines.

0 commit comments

Comments
 (0)