@echo " check to run a check for frequent markup errors"
@echo " serve to serve the documentation on the localhost (8000)"
-build: venv
+build:
-mkdir -p build
# Look first for a Misc/NEWS file (building from a source release tarball
# or old repo) and use that, otherwise look for a Misc/NEWS.d directory
venv:
@if [ -d $(VENVDIR) ] ; then \
- echo "venv already exists"; \
+ echo "venv already exists."; \
+ echo "To recreate it, remove it first with \`make clean-venv'."; \
else \
$(PYTHON) -m venv $(VENVDIR); \
$(VENVDIR)/bin/python3 -m pip install -U pip setuptools; \
----------
To get started on UNIX, you can create a virtual environment and build
-documentation with the command::
+documentation with the commands::
+ make venv
make html
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.
+necessary to build the documentation downloaded and installed from PyPI.
+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 ``sphinxbuild`` 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
``make.bat`` file. If you need to specify the Python interpreter to use,
projects / thirdparty / Python / cpython.git / commitdiff
