Details
-
Type:
Story
-
Status: Won't Fix
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:None
-
Epic Link:
-
Team:SQuaRE
Description
This is a proof-of-concept for building the new Sphinx-based Science Pipelines documentation using Jenkins.
- https://github.com/lsst/pipelines_lsst_io is the core documentation repository
- https://github.com/lsst/validate_base is a package with prototype documentation that can be built with pipelines_lsst_io.
- ltd-mason is the tool that 1) copies package doc directories into pipelines_lsst_io, 2) runs sphinx-build, and 3) uploads to LSST the Docs.
The original approach is abandoned, after pipelines expressed a preference for integrating the the sphinx documentation with scons, as opposed to the approach originall intended when this epic was scoped. Marking WONTFIX, please see epic
DM-6199for fuller explanation