Observatory Controls Documentation

This is the documentation source for the Rubin Observatory Controls Documentation. This documentation is built with Sphinx and published to https://obs-controls.lsst.io.

Contributing

1. Create a virtual environment (if you haven't already):

   python3 -m venv .venv
   source .venv/bin/activate

   Tip: activate this virtual environment in another shell by re-running the source command.

2. Install dependencies:

   python -m pip install --upgrade pip
   python -m pip install -r requirements.txt

3. Build the site:

   make html

   Open _build/html/index.html in a browser to review it.

4. To completely clear the build:

   make clean

5. To check links:

   make linkcheck

   If some links are behind a login, you might need to ignore them. Look at the linkcheck_ignore variable in conf.py for examples of how to do this.

New to Sphinx and the reStructuredText format? Check out our ReStructuredText Style Guide.

Deployment

Whenever you push a GitHub, the site is built for the corresponding branch. Find your build at https://obs-controls.lsst.io/v.

The master branch is always published as https://obs-controls.lsst.io.