Skip to content

Commit 6670c74

Browse files
committed
pythongh-1309: Document how to selectively build RST pages
1 parent 450b560 commit 6670c74

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

documentation/start-documenting.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,25 @@ To build the docs as HTML, run:
153153
start a local server, and automatically reload the page in your
154154
browser when you make changes to reST files (Unix only).
155155

156+
It is also possible to build only certain pages of the documentation in order
157+
to save time during the build process. Following is an example for building two
158+
pages:
159+
160+
.. tab:: Unix/macOS
161+
162+
.. code-block:: shell
163+
164+
make html SOURCES="tutorial/classes.rst tutorial/inputoutput.rst"
165+
166+
.. tab:: Windows
167+
168+
See :ref:`using-sphinx-build`. When invoking ``sphinx-build``, pass the
169+
desired pages as the final parameter, like so:
170+
171+
.. code-block:: dosbatch
172+
173+
python -m sphinx -b html . build/html tutorial/classes.rst tutorial/inputoutput.rst
174+
156175
To check the docs for common errors with `Sphinx Lint`_
157176
(which is run on all :ref:`pull requests <pullrequest>`), use:
158177

0 commit comments

Comments
 (0)