Rubin Data Facilities documentation

This is the source for the Data Facilities documentation at https://df-ops.lsst.io.

Building the documentation

You need Python to compile the documentation site locally. First, create a Python environment and install the development dependencies into it:

python -m venv .venv
source .venv/bin/activate
make init

To compile the documentation, use tox:

tox run -e html

The compiled documentation will be in _build/html.

You can also test formatting and links with other tox environments:

tox run -e lint,linkcheck

The pre-commit hooks, which run in the lint environment, also run automatically when you commit changes. The pre-commit hooks are installed as part of the make init command.

CI and preview

This documentation is built with GitHub Actions. The main branch reflects the df-ops.lsst.io site. Previews of branches are also built and deployed at https://df-ops.lsst.io/v.

For more information about writing Rubin user guides, see the Documenteer documentation.

Adding a Service

To add a new service.

• Copy the service-template folder to docs under the appropriate service grouping
• Rename the copied service-template folder to the service name
• Add the path to the index page for the service grouping