Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:
-
Story Points:3
-
Epic Link:
-
Team:SQuaRE
Description
Since daf_base is low in the dependency tree and dominated by C++ APIs, it is an excellent candidate for exploring Sphinx-based package documenation for C++ with breathe and doxygen. We will also see how astropy’s automodsumm sphinx extension works with SWIG’d Python APIs.
This prototype will build upon the system developed in DM-7094.
Lessons from this prototype will be fed into a "Pipelines Documentation Implementation Planning" tech note in a follow-up ticket.
This prototype in daf_base is not being merged at this time. Lessons learned are being written up in https://dmtn-030.lsst.io (
DM-7096).