Skip to content

Commit 5a4859a

Browse files
jdillardAA-Turner
andauthored
Add docs about sphinx-autobuild (#13011)
Co-authored-by: Adam Turner <[email protected]>
1 parent 05679ef commit 5a4859a

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

doc/internals/contributing.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,12 +270,14 @@ you to preview in :file:`build/sphinx/html`.
270270

271271
You can also build a **live version of the documentation** that you can preview
272272
in the browser. It will detect changes and reload the page any time you make
273-
edits. To do so, run the following command:
273+
edits.
274+
To do so, use `sphinx-autobuild`_ to run the following command:
274275

275276
.. code-block:: shell
276277
277278
sphinx-autobuild ./doc ./build/sphinx/
278279
280+
.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild
279281

280282
Translations
281283
~~~~~~~~~~~~

doc/usage/quickstart.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,17 @@ Sphinx will build HTML files.
148148
Refer to the :doc:`sphinx-build man page </man/sphinx-build>`
149149
for all options that :program:`sphinx-build` supports.
150150

151+
You can also build a **live version of the documentation** that you can preview
152+
in the browser.
153+
It will detect changes and reload the page any time you make edits.
154+
To do so, use `sphinx-autobuild`_ to run the following command:
155+
156+
.. code-block:: console
157+
158+
$ sphinx-autobuild source-dir output-dir
159+
160+
.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild
161+
151162
However, :program:`sphinx-quickstart` script creates a :file:`Makefile` and a
152163
:file:`make.bat` which make life even easier for you. These can be executed by
153164
running :command:`make` with the name of the builder. For example.

0 commit comments

Comments
 (0)