File tree Expand file tree Collapse file tree 2 files changed +14
-1
lines changed Expand file tree Collapse file tree 2 files changed +14
-1
lines changed Original file line number Diff line number Diff line change @@ -270,12 +270,14 @@ you to preview in :file:`build/sphinx/html`.
270270
271271You can also build a **live version of the documentation ** that you can preview
272272in 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
280282Translations
281283~~~~~~~~~~~~
Original file line number Diff line number Diff 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+
151162However, :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
153164running :command: `make ` with the name of the builder. For example.
You can’t perform that action at this time.
0 commit comments