VENVDIR = ./venv

SPHINXBUILD = PATH=$(VENVDIR)/bin:$$PATH sphinx-build

BLURB = PATH=$(VENVDIR)/bin:$$PATH blurb

-rm -rf build/* $(VENVDIR)/*

$(PYTHON) -m venv $(VENVDIR)

$(VENVDIR)/bin/python3 -m pip install -U Sphinx blurb

@echo "The venv has been created in the $(VENVDIR) directory"

$(PYTHON) tools/rstlint.py -i tools -i $(VENVDIR) -i README.rst

The documentation is built with several tools which are not included in this

tree but are maintained separately and are available from

`PyPI <https://pypi.org/>`_.

* `Sphinx <https://pypi.org/project/Sphinx/>`_

* `blurb <https://pypi.org/project/blurb/>`_

The easiest way to install these tools is to create a virtual environment and

install the tools into there.

To get started on UNIX, you can create a virtual environment with the command ::

That will install all the tools necessary to build the documentation. Assuming

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).

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.

* "venv", which creates a virtual environment with all necessary tools

installed.

First, install the tool dependencies from PyPI.

Bugs in the toolset should be reported to the tools themselves.