From 093db2e58de5381d0cfeffa303e10562e1b2153e Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Wed, 15 Nov 2023 21:46:26 +0200 Subject: [PATCH 1/2] Document 'make htmllive' --- Doc/README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Doc/README.rst b/Doc/README.rst index a3bb5fa5445c23..3bf8b5dddbad05 100644 --- a/Doc/README.rst +++ b/Doc/README.rst @@ -62,6 +62,10 @@ Available make targets are: * "htmlview", which re-uses the "html" builder, but then opens the main page in your default web browser. +* "htmllive", which re-uses the "html" builder, rebuilds the docs, + starts a local server, and automatically reloads the page in your browser + when you make changes to reST files (Unix only). + * "htmlhelp", which builds HTML files and a HTML Help project file usable to convert them into a single Compiled HTML (.chm) file -- these are popular under Microsoft Windows, but very handy on every platform. From ff16bcc938c06dddee9c30edd86896dbb1796177 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Wed, 15 Nov 2023 21:52:22 +0200 Subject: [PATCH 2/2] Undocument the removed serve target, update spelling/formatting --- Doc/README.rst | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/Doc/README.rst b/Doc/README.rst index 3bf8b5dddbad05..efcee0db428908 100644 --- a/Doc/README.rst +++ b/Doc/README.rst @@ -28,7 +28,7 @@ install the tools into there. Using make ---------- -To get started on UNIX, you can create a virtual environment and build +To get started on Unix, you can create a virtual environment and build documentation with the commands:: make venv @@ -40,13 +40,13 @@ If you'd like to create the virtual environment in a different location, you can specify it using the ``VENVDIR`` variable. You can also skip creating the virtual environment altogether, in which case -the Makefile will look for instances of ``sphinx-build`` and ``blurb`` +the ``Makefile`` will look for instances of ``sphinx-build`` and ``blurb`` installed on your process ``PATH`` (configurable with the ``SPHINXBUILD`` and ``BLURB`` variables). -On Windows, we try to emulate the Makefile as closely as possible with a +On Windows, we try to emulate the ``Makefile`` as closely as possible with a ``make.bat`` file. If you need to specify the Python interpreter to use, -set the PYTHON environment variable. +set the ``PYTHON`` environment variable. Available make targets are: @@ -71,10 +71,10 @@ Available make targets are: under Microsoft Windows, but very handy on every platform. To create the CHM file, you need to run the Microsoft HTML Help Workshop - over the generated project (.hhp) file. The make.bat script does this for + over the generated project (.hhp) file. The ``make.bat`` script does this for you on Windows. -* "latex", which builds LaTeX source files as input to "pdflatex" to produce +* "latex", which builds LaTeX source files as input to ``pdflatex`` to produce PDF documents. * "text", which builds a plain text file for each source file. @@ -99,8 +99,6 @@ Available make targets are: * "check", which checks for frequent markup errors. -* "serve", which serves the build/html directory on port 8000. - * "dist", (Unix only) which creates distributable archives of HTML, text, PDF, and EPUB builds.