mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-02 11:08:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 14

Doc/README: Document 'make htmllive' (#120692)

Browse source 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
This commit is contained in:
Hugo van Kemenade 2024-06-25 03:08:55 -06:00 • committed by GitHub
parent 9b32b89074
commit ead676516d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Doc/README.rst
View file

@ -28,7 +28,7 @@ install the tools into there.
Using make 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:: documentation with the commands::
make venv 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 specify it using the ``VENVDIR`` variable.
You can also skip creating the virtual environment altogether, in which case 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 installed on your process ``PATH`` (configurable with the ``SPHINXBUILD`` and
``BLURB`` variables). ``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, ``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: Available make targets are:
@ -62,15 +62,19 @@ Available make targets are:
* "htmlview", which re-uses the "html" builder, but then opens the main page * "htmlview", which re-uses the "html" builder, but then opens the main page
in your default web browser. 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 * "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 convert them into a single Compiled HTML (.chm) file -- these are popular
under Microsoft Windows, but very handy on every platform. under Microsoft Windows, but very handy on every platform.
To create the CHM file, you need to run the Microsoft HTML Help Workshop 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. 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. PDF documents.
* "text", which builds a plain text file for each source file. * "text", which builds a plain text file for each source file.
@ -95,8 +99,6 @@ Available make targets are:
* "check", which checks for frequent markup errors. * "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, * "dist", (Unix only) which creates distributable archives of HTML, text,
PDF, and EPUB builds. PDF, and EPUB builds.