Documenteer
  • Forum
  • Docs
  • LSST.org →

Navigation

  • next »
  • « previous |
  • Documenteer »
  • Documenteer for LSST Science Pipelines (stack) documentation

Documenteer for LSST Science Pipelines (stack) documentation¶

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
    • Prerequisites
    • Pip installation of Documenteer
    • 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)

On this page

  • Documenteer for LSST Science Pipelines (stack) documentation

  Back to Top

Created using Sphinx 3.2.1. Page design is based on Astropy's bootstrap-astropy theme in astropy-helpers.
LSST documentation is proudly served through the Fastly CDN.

© Copyright 2015-2020 Association of Universities for Research in Astronomy, Inc. (AURA).

Financial support for LSST comes from the National Science Foundation (NSF) through Cooperative Agreement No. 1258333, the Department of Energy (DOE) Office of Science under Contract No. DE-AC02-76SF00515, and private funding raised by the LSST Corporation. The NSF-funded LSST Project Office for construction was established as an operating center under management of the Association of Universities for Research in Astronomy (AURA). The DOE-funded effort to build the LSST camera is managed by the SLAC National Accelerator Laboratory (SLAC).