From 65872ac0fadc964ec23ad1cc58de7ea3448bd84f Mon Sep 17 00:00:00 2001 From: teald Date: Wed, 14 Aug 2024 12:56:46 -0700 Subject: [PATCH] docs(nox,examples): Remove example references This removes all references to the examples section made through links. It also sets nox to raise sphinx warnings as errors (using `sphinx-build -W`). --- docs/index.rst | 1 - docs/manuals/index.rst | 2 -- docs/manuals/progmanual/intro.rst | 2 +- docs/manuals/usermanual/structure.rst | 5 ----- noxfile.py | 2 +- 5 files changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 70fe2ea8..d748b163 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,7 +9,6 @@ This is the documentation for astrodata. quickstart.rst manuals/index - examples/index developer/index api_short diff --git a/docs/manuals/index.rst b/docs/manuals/index.rst index d97ca62e..f967c879 100644 --- a/docs/manuals/index.rst +++ b/docs/manuals/index.rst @@ -17,7 +17,6 @@ Astrodata Manual cheatsheet usermanual/index progmanual/index - ../examples/index full_api This documentation provides different levels of information: @@ -26,7 +25,6 @@ This documentation provides different levels of information: - :doc:`usermanual/index` - How to code with astrodata objects - :doc:`progmanual/index` - How to code for astrodata - :doc:`full_api` - The full API documentation for developers. -- :doc:`../examples/index` - Examples of how to use astrodata If you need support related to |astrodata|, see :ref:`ad_support`. diff --git a/docs/manuals/progmanual/intro.rst b/docs/manuals/progmanual/intro.rst index 4b9a06d9..4167a52d 100644 --- a/docs/manuals/progmanual/intro.rst +++ b/docs/manuals/progmanual/intro.rst @@ -35,7 +35,7 @@ For the programmer using |AstroData| to develop a data reduction pipeline, the |AstroData| class should be subclassed to provide the functionality required and to register the new class with the :func:`~astrodata.from_file` function. -Several examples may be found throughout the documentation (see |Examples|). A +Several examples may be found throughout the documentation. A simple example is shown below as a complete, executable introduction. .. code-block:: python diff --git a/docs/manuals/usermanual/structure.rst b/docs/manuals/usermanual/structure.rst index 5c6ddfaf..80873a7a 100644 --- a/docs/manuals/usermanual/structure.rst +++ b/docs/manuals/usermanual/structure.rst @@ -16,11 +16,6 @@ The internal structure of the |AstroData| object makes uses of astropy's :class:`~astropy.io.fits.Header`, the latter simply because it is a convenient ordered dictionary. -Example location ----------------- - -The examples in this section can be found here: :ref:`user_structure_examples`. - Walkthrough ----------- diff --git a/noxfile.py b/noxfile.py index 139673ed..7021273f 100644 --- a/noxfile.py +++ b/noxfile.py @@ -673,7 +673,7 @@ def docs(session: nox.Session) -> None: # TODO(teald): Add nitpicky flag to fix warnings. -- Issue #42 target = Path("_build") session.run("rm", "-rf", target, external=True) - session.run("sphinx-build", "docs", target) + session.run("sphinx-build", "-W", "docs", target) def use_devpi_server(func):