Document 'make htmllive' (#1219)

python · Nov 15, 2023 · 339cb89 · 339cb89
1 parent 679d64b
commit 339cb89
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/documentation/devguide.rst b/documentation/devguide.rst
@@ -42,9 +42,15 @@ in the checkout directory.  On Windows use:
 
    > .\make html
 
-You will find the generated files in ``_build/html`` or, if you use
-``make htmlview``, the docs will be opened in a browser once the build
-completes.  Note that ``make check`` runs automatically when you submit
+You will find the generated files in ``_build/html``.
+
+.. tip:: * Replace ``html`` with ``htmlview`` to open the docs in a web browser
+           once the build completes.
+         * Replace ``html`` with ``htmllive`` to rebuild the docs,
+           start a local server, and automatically reload the page in your
+           browser when you make changes to reST files (Unix only).
+
+Note that ``make check`` runs automatically when you submit
 a :ref:`pull request <pullrequest>`.  You may wish to run ``make check``
 and ``make linkcheck`` to make sure that it runs without errors.
 

diff --git a/documentation/start-documenting.rst b/documentation/start-documenting.rst
@@ -122,8 +122,11 @@ To build the docs as HTML, run::
 
    make html
 
-.. tip:: Substitute ``htmlview`` for ``html`` to open the docs in a web browser
-         once the build completes.
+.. tip:: * Replace ``html`` with ``htmlview`` to open the docs in a web browser
+           once the build completes.
+         * Replace ``html`` with ``htmllive`` to rebuild the docs,
+           start a local server, and automatically reload the page in your
+           browser when you make changes to reST files (Unix only).
 
 To check the docs for common errors with `Sphinx Lint`_
 (which is run on all :ref:`pull requests <pullrequest>`), use::