File tree Expand file tree Collapse file tree 3 files changed +16
-5
lines changed
Misc/NEWS.d/next/Documentation Expand file tree Collapse file tree 3 files changed +16
-5
lines changed Original file line number Diff line number Diff line change 4545 @echo " check to run a check for frequent markup errors"
4646 @echo " serve to serve the documentation on the localhost (8000)"
4747
48- build : venv
48+ build :
4949 -mkdir -p build
5050# Look first for a Misc/NEWS file (building from a source release tarball
5151# or old repo) and use that, otherwise look for a Misc/NEWS.d directory
@@ -145,7 +145,8 @@ clean-venv:
145145
146146venv :
147147 @if [ -d $( VENVDIR) ] ; then \
148- echo " venv already exists" ; \
148+ echo " venv already exists." ; \
149+ echo " To recreate it, remove it first with \` make clean-venv'." ; \
149150 else \
150151 $(PYTHON ) -m venv $(VENVDIR ) ; \
151152 $(VENVDIR ) /bin/python3 -m pip install -U pip setuptools; \
Original file line number Diff line number Diff line change @@ -29,13 +29,20 @@ Using make
2929----------
3030
3131To get started on UNIX, you can create a virtual environment and build
32- documentation with the command ::
32+ documentation with the commands ::
3333
34+ make venv
3435 make html
3536
3637The virtual environment in the ``venv `` directory will contain all the tools
37- necessary to build the documentation. You can also configure where the virtual
38- environment directory will be with the ``VENVDIR `` variable.
38+ necessary to build the documentation downloaded and installed from PyPI.
39+ If you'd like to create the virtual environment in a different location,
40+ you can specify it using the ``VENVDIR `` variable.
41+
42+ You can also skip creating the virtual environment altogether, in which case
43+ the Makefile will look for instances of ``sphinxbuild `` and ``blurb ``
44+ installed on your process ``PATH `` (configurable with the ``SPHINXBUILD `` and
45+ ``BLURB `` variables).
3946
4047On Windows, we try to emulate the Makefile as closely as possible with a
4148``make.bat `` file. If you need to specify the Python interpreter to use,
Original file line number Diff line number Diff line change 1+ Reverted automated virtual environment creation on ``make html `` when
2+ building documentation. It turned out to be disruptive for downstream
3+ distributors.
You can’t perform that action at this time.
0 commit comments