summaryrefslogtreecommitdiffstats
path: root/Doc/README.rst
diff options
context:
space:
mode:
authorJack DeVries <58614260+jdevries3133@users.noreply.github.com>2021-07-28 13:13:28 (GMT)
committerGitHub <noreply@github.com>2021-07-28 13:13:28 (GMT)
commitd22c876d5ac5fa464337d2e82654b8d87a83cb1b (patch)
tree0c4517dc35f1876d426a5cb7acbb5965a00c747f /Doc/README.rst
parentddf8ae31a0f371eff2db14c7f7a45976b86d56ea (diff)
downloadcpython-d22c876d5ac5fa464337d2e82654b8d87a83cb1b.zip
cpython-d22c876d5ac5fa464337d2e82654b8d87a83cb1b.tar.gz
cpython-d22c876d5ac5fa464337d2e82654b8d87a83cb1b.tar.bz2
bpo-44756: in ./Doc, `make build` depends on `make html` (#27403)
- venv rule is now conditional, and only does anything if $VENVDIR does not exist - add rule "clean-venv"
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.