Pipelines

The LSST Science Pipelines is an EUPS-managed stack. Documenteer includes specific command-line tools and Sphinx configurations to build documentation for both multi-package stacks (such as pipelines.lsst.io) as well as individual or stand-alone stack packages (such as astro-metadata-translator.lsst.io). Documenteer also includes Sphinx extensions to help document domain-specific topics, such as LSST Tasks.

• Installing Documenteer for pipelines.lsst.io
  • Pip installation of Documenteer
  • Conda installation
  • Next steps
• Overview of the pipelines.lsst.io build system
  • Documenteer
  • Stack build and set up
  • Doxygen build
  • Package documentation linking
  • The Sphinx build
  • Python API reference
  • Related reading
• stack-docs command-line app
  • stack-docs
• package-docs command-line app
  • package-docs
• Sphinx configuration for stacks and packages
  • Sphinx configuration for stack documentation projects
  • Sphinx configuration for packages
  • Configuration source reference
• Cross-linking the Doxygen-built C++ API reference with the lsstcc role
  • Link to C++ APIs with the lsstcc role
  • Listing linkable C++ APIs (stack-docs listcc)