Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:
-
Story Points:5.1
-
Epic Link:
-
Team:SQuaRE
Description
With DMTN-030 we have a conceptual design for Science Pipelines package documentation design. I've realized part of that concept in pipe_base documentation (DM-1253). The next step is to document these content patterns and the Git repository layout more precisely so that the pipe_base documentation effort can be replicated by anyone in any other package.
I think we want to continue to use the lsst/templates repository for this type of package documentation. Two key issues with lsst/templates are:
- It's filled with non-essential content (like a pybind11 example)
- It's hard in that example format to document libraries of repeatable content snippets, like Task documentation pages, for example, that aren't essential parts of a package, but are nontheless standardized.
This ticket is intended to prototype a new organization of the lsst/templates repository that allows more effective documentation of both package structure and documentation templates.
Some design goals are:
- Eventual compatibility with cookiecutter.
- Ability to document repeating content fragments in a way where an original source of truth is clear, and that templated information is propagated throughout the template project.
- Ability to have template documentation alongside the template itself.
On a practical level, Simon Krughoff notes that obs_test is probably a more up-to-date example of a package than the lsst/templates repository is.
Attachments
Issue Links
- is triggered by
-
RFC-376 New organization for the templates repository
- Implemented
- is triggering
-
DM-11699 Create a example auto-build system for the templates repository
- Done
- relates to
-
DM-12674 Revert Sphinx additions to stack package template repos (until production-ready)
- Done
-
DM-12687 Add stack_package cookiecutter template
- Done
-
DM-7097 Develop README, CONTRIBUTING templates for stack packages
- Won't Fix
-
DM-7198 Document template for EUPS Stack packages in developer guide
- Invalid
DM-8560– could do it today since everything works, although some people get squeamish at the thought of relying on software that is being called an "alpha release". I have no idea what the timescale is for the final v3.0 release of SCons.