diff --git a/docs/src/common.txt b/docs/src/common.txt index b0b5dd71..7a882ed5 100644 --- a/docs/src/common.txt +++ b/docs/src/common.txt @@ -9,7 +9,6 @@ .. _GeoVista: https://github.com/bjlittle/geovista .. _Issue: https://github.com/bjlittle/geovista/issues .. _Issues: https://github.com/bjlittle/geovista/issues -.. _Jupyter: https://jupyter.org/ .. _Kitware: https://www.kitware.com/ .. _Matplotlib: https://github.com/matplotlib/matplotlib .. _Natural Earth Features: https://www.naturalearthdata.com/features/ @@ -39,7 +38,6 @@ .. _geovista-data: https://github.com/bjlittle/geovista-data .. _geovista-media: https://github.com/bjlittle/geovista-media .. _iris: https://github.com/scitools/iris -.. _make: https://www.gnu.org/software/make/ .. _matplotlib: https://github.com/matplotlib/matplotlib .. _myst-nb: https://github.com/executablebooks/MyST-NB .. _myst-parser: https://github.com/executablebooks/MyST-Parser diff --git a/docs/src/conf.py b/docs/src/conf.py index 2b1aee6f..ca157801 100644 --- a/docs/src/conf.py +++ b/docs/src/conf.py @@ -509,6 +509,7 @@ def autolog(message: str, section: str | None = None, color: str | None = None) "https://www.ncei.noaa.gov/products/optimum-interpolation-sst", "https://earthexplorer.usgs.gov", "https://www.fvcom.org", + "https://www.gnu.org/software/make/", ] linkcheck_retries = 3 diff --git a/docs/src/developer/documentation.rst b/docs/src/developer/documentation.rst index fe0efeb5..a33d3cd7 100644 --- a/docs/src/developer/documentation.rst +++ b/docs/src/developer/documentation.rst @@ -17,14 +17,14 @@ The documentation is built using `sphinx`_ to parse and render `reStructuredText We also use `myst-parser`_, a ``sphinx`` and `docutils`_ extension to parse and convert :term:`MyST` to ``rst``, and `myst-nb`_ to execute and convert -`Jupyter Notebooks `_ into ``sphinx`` documents. +`Jupyter Notebooks`_ into ``sphinx`` documents. .. seealso:: :class: margin, dropdown, toggle-shown For configuration details see ``Makefile`` and ``conf.py``. -The documentation is built using `sphinx-build`_ and the `GNU make `_ tool. +The documentation is built using `sphinx-build`_ and the `GNU make`_ tool. :fa:`pump-medical` Hygiene @@ -93,12 +93,12 @@ How-to serve the rendered documentation for inspection in a local browser. :widths: 1 3 :align: center - +------------------------+----------------------------------------------------------------------------------+ - | Make Command | Description | - +========================+==================================================================================+ - | :guilabel:`serve-html` | Start a local ``HTTP`` server to view the rendered documentation. This is | - | | necessary to in order to support the interactive scenes. | - +------------------------+----------------------------------------------------------------------------------+ + +------------------------+-------------------------------------------------------------------------------------+ + | Make Command | Description | + +========================+=====================================================================================+ + | :guilabel:`serve-html` | Start a local ``HTTP`` server on port ``11000`` to view the rendered documentation. | + | | This is necessary in order to support interactive scenes. | + +------------------------+-------------------------------------------------------------------------------------+ :fa:`vial-circle-check` Test @@ -125,5 +125,7 @@ Perform documentation quality assurance. Page link URL resources in alphabetical order: +.. _GNU make: https://www.gnu.org/software/make/ +.. _Jupyter Notebooks: https://jupyter.org/ .. _myst-nb configuration: https://myst-nb.readthedocs.io/en/latest/configuration.html .. _sphinx linkcheck builder: https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder