Documenteer#

Sphinx extensions, configurations, and tooling for Rubin Observatory documentation projects.

Documenteer is developed on GitHub at lsst-sqre/documenteer. Find other versions of the documentation at https://documenteer.lsst.io/v

Installation#

The core package provides Documenteer’s Sphinx extensions:

pip install documenteer

To use Documenteer’s configurations for specific Rubin documentation use cases, you’ll need to install Documenteer with specific “extras” to bring in the necessary dependencies.

For Rubin user guide projects:

pip install "documenteer[guide]"

For technote projects:

pip install "documenteer[technote]"

For LSST Science Pipelines projects and other EUPS stacks:

pip install "documenteer[pipelines]"

See Installing Documenteer for pipelines.lsst.io for more information.

Documenteer is available from conda-forge for Conda users. First, enable the conda-forge channel:

conda config --add channels conda-forge
conda config --set channel_priority strict

The core package provides Documenteer’s Sphinx extensions:

conda install documenteer

To use Documenteer’s configurations for specific Rubin documentation use cases, you’ll need to install Documenteer with specific “extras” to bring in the necessary dependencies.

To install Documenteer for technote projects:

conda-install lsst-documenteer-technote

To install Documenteer for LSST Stack projects (such as https://pipelines.lsst.io and EUPS packages):

conda-install lsst-documenteer-pipelines

Project guides#

Documenteer provides centralized Sphinx configuration and support for Rubin Observatory documentation projects. This section describes how to use Documenteer for specific types of projects, from single-page technical notes to user guides, to LSST Science Pipelines package documentation.

Sphinx extensions#

Documenteer provides several Sphinx extensions. These extensions are designed for Rubin Observatory documentation projects, but are may be generally useful:

Developer guide#