Building the Documentation

autojob uses Sphinx to build its documentation.

If you are using hatch to manage environments, you can install the “docs” environment and build the documentation using:

hatch env run docs:build-html

This is effectively equivalent to running:

pip install -e .'[docs]'
sphinx-build -b html docs/source docs/build/html/

The above commands will run sphinx-apidoc on the codebase and build the HTML files from the existing .rst files. To run a local server to view changes to the documentation, you can run:

hatch env run docs:serve

or explicitly run sphinx-autobuild:

sphinx-autobuild --port 0 docs/source docs/build/