IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add docs about sphinx-autobuild (#13011)

Browse Source 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
This commit is contained in:
Jared Dillard 2024-10-12 11:07:23 -07:00 committed by GitHub
parent 05679efe7b
commit 5a4859a2e4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/internals/contributing.rst
View File

@ -270,12 +270,14 @@ you to preview in :file:`build/sphinx/html`.
You can also build a **live version of the documentation** that you can preview You can also build a **live version of the documentation** that you can preview
in the browser. It will detect changes and reload the page any time you make in the browser. It will detect changes and reload the page any time you make
edits. To do so, run the following command: edits.
To do so, use `sphinx-autobuild`_ to run the following command:
.. code-block:: shell .. code-block:: shell
sphinx-autobuild ./doc ./build/sphinx/ sphinx-autobuild ./doc ./build/sphinx/
.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild
Translations Translations
~~~~~~~~~~~~ ~~~~~~~~~~~~

11
doc/usage/quickstart.rst
View File

@ -148,6 +148,17 @@ Sphinx will build HTML files.
Refer to the :doc:`sphinx-build man page </man/sphinx-build>` Refer to the :doc:`sphinx-build man page </man/sphinx-build>`
for all options that :program:`sphinx-build` supports. for all options that :program:`sphinx-build` supports.
You can also build a **live version of the documentation** that you can preview
in the browser.
It will detect changes and reload the page any time you make edits.
To do so, use `sphinx-autobuild`_ to run the following command:
.. code-block:: console
$ sphinx-autobuild source-dir output-dir
.. _sphinx-autobuild: https://github.com/sphinx-doc/sphinx-autobuild
However, :program:`sphinx-quickstart` script creates a :file:`Makefile` and a However, :program:`sphinx-quickstart` script creates a :file:`Makefile` and a
:file:`make.bat` which make life even easier for you. These can be executed by :file:`make.bat` which make life even easier for you. These can be executed by
running :command:`make` with the name of the builder. For example. running :command:`make` with the name of the builder. For example.