From 6670c74b8900974930c2874e1ed368c1e2262d23 Mon Sep 17 00:00:00 2001 From: Micha Albert Date: Mon, 19 May 2025 10:23:36 -0400 Subject: [PATCH] gh-1309: Document how to selectively build RST pages --- documentation/start-documenting.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/documentation/start-documenting.rst b/documentation/start-documenting.rst index 184cf54bf..973b36b12 100644 --- a/documentation/start-documenting.rst +++ b/documentation/start-documenting.rst @@ -153,6 +153,25 @@ To build the docs as HTML, run: start a local server, and automatically reload the page in your browser when you make changes to reST files (Unix only). +It is also possible to build only certain pages of the documentation in order +to save time during the build process. Following is an example for building two +pages: + +.. tab:: Unix/macOS + + .. code-block:: shell + + make html SOURCES="tutorial/classes.rst tutorial/inputoutput.rst" + +.. tab:: Windows + + See :ref:`using-sphinx-build`. When invoking ``sphinx-build``, pass the + desired pages as the final parameter, like so: + + .. code-block:: dosbatch + + python -m sphinx -b html . build/html tutorial/classes.rst tutorial/inputoutput.rst + To check the docs for common errors with `Sphinx Lint`_ (which is run on all :ref:`pull requests `), use: