Build the documentation#
Like other Rubin Observatory projects, Squareone’s documentation is build with Sphinx using the Documenteer package for configuration and theming. Sphinx runs in a Python environment. To set up the environment, see Python dependencies for documentation in the set-up guide.
Build the documentation#
Run the documentation build through Nox, which will set up the environment and run Sphinx:
nox -s docs
Test links#
Run a link checker:
nox -s docs-linkcheck