Build the documentation¶

Use the provided Makefile to install the documentation requirements:

makesetup-docs

Once the requirements are installed, you can use the provided Makefile to build the documentation:

makedocs# the home page can be found at docs/_build/html/index.html

Even better, serve it on http://127.0.0.1:8000/. The documentation will be rebuilt on each file change, and will reload the browser view.

makedocs-auto

Note that make docs-auto automatically activates the virtual environment, as long as it already exists.