summaryrefslogtreecommitdiffstats
path: root/Doc/README.rst
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-07-28 13:35:18 (GMT)
committerGitHub <noreply@github.com>2021-07-28 13:35:18 (GMT)
commitf113195ac85d58bdde348b5bb74eb97e6485e408 (patch)
tree4773d47a878f29e3edb377f0475c77044d5d4fbb /Doc/README.rst
parentc558e12695e5fe39778eb3eead9df48870356800 (diff)
downloadcpython-f113195ac85d58bdde348b5bb74eb97e6485e408.zip
cpython-f113195ac85d58bdde348b5bb74eb97e6485e408.tar.gz
cpython-f113195ac85d58bdde348b5bb74eb97e6485e408.tar.bz2
bpo-44756: in ./Doc, `make build` depends on `make html` (GH-27403) (GH-27410)
- venv rule is now conditional, and only does anything if $VENVDIR does not exist - add rule "clean-venv" (cherry picked from commit d22c876d5ac5fa464337d2e82654b8d87a83cb1b) Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
Diffstat (limited to 'Doc/README.rst')
-rw-r--r--Doc/README.rst22
1 files changed, 9 insertions, 13 deletions
diff --git a/Doc/README.rst b/Doc/README.rst
index 380ea4f..20c0432 100644
--- a/Doc/README.rst
+++ b/Doc/README.rst
@@ -28,28 +28,24 @@ install the tools into there.
Using make
----------
-To get started on UNIX, you can create a virtual environment with the command ::
-
- make venv
-
-That will install all the tools necessary to build the documentation. Assuming
-the virtual environment was created in the ``venv`` directory (the default;
-configurable with the VENVDIR variable), you can run the following command to
-build the HTML output files::
+To get started on UNIX, you can create a virtual environment and build
+documentation with the command::
make html
-By default, if the virtual environment is not created, the Makefile will
-look for instances of sphinxbuild and blurb installed on your process PATH
-(configurable with the SPHINXBUILD and BLURB variables).
+The virtual environment in the ``venv`` directory will contain all the tools
+necessary to build the documentation. You can also configure where the virtual
+environment directory will be with the ``VENVDIR`` variable.
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 instead.
+set the PYTHON environment variable.
Available make targets are:
-* "clean", which removes all build files.
+* "clean", which removes all build files and the virtual environment.
+
+* "clean-venv", which removes the virtual environment directory.
* "venv", which creates a virtual environment with all necessary tools
installed.