diff --git a/docs/api.rst b/docs/api.rst index 2addaabd8..088d3c7cf 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -151,6 +151,8 @@ Connectivity Grid.node_face_connectivity +.. _descriptors: + Descriptors ~~~~~~~~~~~ .. autosummary:: @@ -565,6 +567,8 @@ Azimuthal aggregations apply an aggregation (i.e. averaging) along circles of co UxDataArray.azimuthal_mean +.. _zonal-average: + Zonal Average ~~~~~~~~~~~~~ .. autosummary:: @@ -586,6 +590,8 @@ Weighted Spherical Geometry ------------------ +.. _intersections: + Intersections ~~~~~~~~~~~~~ @@ -597,6 +603,8 @@ Intersections grid.intersections.get_number_of_intersections +.. _arcs: + Arcs ~~~~ @@ -610,6 +618,8 @@ Arcs grid.arcs.on_minor_arc +.. _compensated-arithmetic: + Compensated Arithmetic ---------------------- diff --git a/docs/citations-for-algorithms.rst b/docs/citations-for-algorithms.rst index 2aa7d73df..6b5362ab4 100644 --- a/docs/citations-for-algorithms.rst +++ b/docs/citations-for-algorithms.rst @@ -74,54 +74,54 @@ Algorithm-to-Publication Mapping * - Documentation section - API or implementation - Required citation(s) - * - `Descriptors `__ + * - :ref:`Descriptors ` - :py:attr:`~uxarray.Grid.bounds` :py:attr:`~uxarray.Grid.face_bounds_lon` :py:attr:`~uxarray.Grid.face_bounds_lat` - |cite-gmd| - * - `Zonal Average `__ + * - :ref:`Zonal Average ` - All zonal-average remapping implementations (e.g. :py:meth:`~uxarray.UxDataArray.zonal_mean`) - |cite-siam| - * - `Spherical Geometry: Intersections `__ + * - :ref:`Spherical Geometry: Intersections ` - All spherical-intersection APIs in this section (:py:func:`~uxarray.grid.intersections.gca_gca_intersection`, :py:func:`~uxarray.grid.intersections.gca_const_lat_intersection`, :py:func:`~uxarray.grid.intersections.get_number_of_intersections`) - **Cite both:** |cite-gmd| |cite-siam| - * - `Spherical Geometry: Arcs `__ + * - :ref:`Spherical Geometry: Arcs ` - :py:func:`~uxarray.grid.arcs.in_between` :py:func:`~uxarray.grid.arcs.point_within_gca` - No new citation required. Expected to be removed in a future release. - * - `Spherical Geometry: Arcs `__ + * - :ref:`Spherical Geometry: Arcs ` - :py:func:`~uxarray.grid.arcs.extreme_gca_latitude` - |cite-gmd| - * - `Spherical Geometry: Arcs `__ + * - :ref:`Spherical Geometry: Arcs ` - :py:func:`~uxarray.grid.arcs.orient3d_on_sphere` :py:func:`~uxarray.grid.arcs.on_minor_arc` - |cite-shewchuk| - * - `Compensated Arithmetic `__ + * - :ref:`Compensated Arithmetic ` - :py:func:`~uxarray.utils.computing.two_sum` - |cite-knuth| - * - `Compensated Arithmetic `__ + * - :ref:`Compensated Arithmetic ` - :py:func:`~uxarray.utils.computing.two_prod` - |cite-dekker| - * - `Compensated Arithmetic `__ + * - :ref:`Compensated Arithmetic ` - :py:func:`~uxarray.utils.computing.diff_of_products` - **Cite both:** |cite-higham| |cite-jeannerod| - * - `Compensated Arithmetic `__ + * - :ref:`Compensated Arithmetic ` - :py:func:`~uxarray.utils.computing.accucross` :py:func:`~uxarray.utils.computing.accucross_pair` - |cite-gmd| - * - `Compensated Arithmetic `__ + * - :ref:`Compensated Arithmetic ` - :py:func:`~uxarray.utils.computing.acc_sqrt_re` - |cite-rump| diff --git a/docs/conf.py b/docs/conf.py index 7dbde46aa..a7ab0b6b5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -245,6 +245,8 @@ def __getattr__(cls, name): r"https://healpix.sourceforge.io/*", r"https://zenodo.org/*", r"https://doi.org/10.5281/zenodo*", + r"https://stackoverflow.com/*", # Cloudflare bot protection + r"https://doi.org/10.1137/*", # SIAM DOIs -> epubs.siam.org blocks bots # More URLs as needed ] diff --git a/docs/contributing.rst b/docs/contributing.rst index c917c8473..3e2570cbc 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -117,7 +117,7 @@ homepage `_). Git has lots and lots of commands, each with lots and lots of options. Even if we can cover some of them throughout this guide, your best friend for figuring out to do things with Git may be Google, and in particular - `StackOverflow `_. + `StackOverflow `_. Configure your environment to authenticate with GitHub from Git. This is a complicated process, so we suggest that you refer to the details in the