Documenteer

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

Documenteer is developed on GitHub at https://github.com/lsst-sqre/documenteer.

Getting started

Sphinx extensions

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

Pipelines projects

A guide to using Documenteer for LSST Science Pipelines documentation:

Technote projects

A guide to writing reStructuredText-formatted Rubin Observatory technical notes (technotes) using Sphinx and Documenteer:

Reference

Developer guide