Merge pull request #91 from csiro-coasts/docs-updates

Small docs tweaks

Author: mx-moth

continuous-integration/requirements.txt

@@ -4,10 +4,14 @@
 #
 #    pip-compile --extra=testing --output-file=continuous-integration/requirements.txt setup.cfg
 #
+accessible-pygments==0.0.4
+    # via pydata-sphinx-theme
 alabaster==0.7.13
     # via sphinx
 babel==2.12.1
-    # via sphinx
+    # via
+    #   pydata-sphinx-theme
+    #   sphinx
 beautifulsoup4==4.12.2
     # via pydata-sphinx-theme
 bottleneck==1.3.7
@@ -145,12 +149,15 @@ pyarrow==12.0.0
     # via dask
 pycodestyle==2.10.0
     # via flake8
-pydata-sphinx-theme==0.8.1
+pydata-sphinx-theme==0.13.3
     # via sphinx-book-theme
 pyflakes==3.0.1
     # via flake8
 pygments==2.15.1
-    # via sphinx
+    # via
+    #   accessible-pygments
+    #   pydata-sphinx-theme
+    #   sphinx
 pykdtree==1.3.7.post0
     # via emsarray (setup.cfg)
 pyparsing==3.0.9
@@ -176,9 +183,7 @@ python-dateutil==2.8.2
 pytz==2023.3
     # via pandas
 pyyaml==6.0
-    # via
-    #   dask
-    #   sphinx-book-theme
+    # via dask
 requests==2.30.0
     # via
     #   pooch
@@ -200,7 +205,7 @@ sphinx==4.3.2
     #   emsarray (setup.cfg)
     #   pydata-sphinx-theme
     #   sphinx-book-theme
-sphinx-book-theme==0.3.3
+sphinx-book-theme==1.0.1
     # via emsarray (setup.cfg)
 sphinxcontrib-applehelp==1.0.4
     # via sphinx
@@ -234,7 +239,9 @@ types-pytz==2023.3.0.0
     #   emsarray (setup.cfg)
     #   pandas-stubs
 typing-extensions==4.5.0
-    # via mypy
+    # via
+    #   mypy
+    #   pydata-sphinx-theme
 tzdata==2023.3
     # via pandas
 urllib3==2.0.2

docs/developing/conventions.rst

@@ -99,7 +99,7 @@ This selector can be used to subset the dataset to a single grid index.
 .. literalinclude:: ./grass.py
    :pyobject: Grass.selector_for_index
 
-:attr:`.Convention.polygons` is an array of shapely :class:`Polygon` instances,
+:attr:`.Convention.polygons` is an array of :class:`shapely.Polygon` instances,
 one for each face in the dataset.
 If a cell does not have a valid polygon
 --- for example, if the coordinates for that polygon have been dropped

docs/releases/development.rst

@@ -14,3 +14,6 @@ Next release (in development)
   deprecate :meth:`.Convention.get_times()` and :meth:`.Convention.get_depths()`
   (:pr:`92`).
 * Add :meth:`.Convention.select_variables` (:pr:`93`).
+* Fix various small issues with the docs.
+  Use newer version of ``sphinx-book-theme`` for documentation
+  (:pr:`91`).

setup.cfg

@@ -53,7 +53,7 @@ complete =
 
 docs =
 	sphinx ~=4.3.1
-	sphinx_book_theme ~=0.3.2
+	sphinx_book_theme ~=1.0.1
 	livereload~=2.6.3
 
 testing =

src/emsarray/cli/__init__.py

@@ -33,7 +33,7 @@ def main(options: argparse.Namespace) -> None:
     """
     The main entry point for :mod:`emsarray` as a command line utility.
 
-    See also
+    See Also
     --------
     :ref:`cli`
     """

src/emsarray/cli/exceptions.py

@@ -1,7 +1,7 @@
 class CommandException(RuntimeError):
     """Raise this to exit a command line script gracefully.
 
-    See also
+    See Also
     --------
     :func:`.utils.console_entrypoint`
     """

src/emsarray/cli/utils.py

@@ -99,7 +99,7 @@ def main(argv: Optional[List[str]]) -> None:
 
             ...  # Continue on with the rest of the program
 
-    See also
+    See Also
     --------
 
     :func:`.nice_console_errors`
@@ -336,7 +336,7 @@ def geometry_argument(argument_string: str) -> BaseGeometry:
 def bounds_argument(bounds_string: str) -> BaseGeometry:
     """
     Parse a comma separated string of (lon_min, lat_min, lon_max, lat_max)
-    in to a :class:`shapely.geometry.Polygon`. Used as an :mod:`argparse`
+    in to a :class:`shapely.Polygon`. Used as an :mod:`argparse`
     parameter ``type``.
 
     Example