Building documentation¶

Important

Ensure nox is installed. If you executed the first steps in some way, you should be all set.

Build once¶

To build your documentation once:

nox -e docs
# or: make docs

The rendered documentation will be located in docs/_build/html.

For continuous development, you can start a live preview that automatically reloads when changes are made:

nox -e docs-dev
# or: make docs-dev

This command builds the documentation, starts an HTTP server, opens your default browser, and watches for changes.

Note

If building on a remote system, override the default localhost host with:

nox -e docs-dev -- --host=1.2.3.4