Details
-
Type:
Story
-
Status: To Do
-
Resolution: Unresolved
-
Fix Version/s: None
-
Component/s: Continuous Integration, Stack Documentation and UX
-
Labels:
-
Team:SQuaRE
Description
The doxygen pages (http://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/annotated.html) currently don't include any of the obs packages (e.g., obs_lsstSim, obs_cfht, obs_subaru). These packages contain useful code, and their documentation should be merged in with that in Doxygen.
This may be difficult, given that we want to keep the obs packages separate in some manner from the rest.
Attachments
Issue Links
- relates to
-
DM-13074 doxygen.lsst.codes master index.html page broken
- Done
I've looked over the BB code invoking the doxygen build. It builds the datarel product currently. I can easily make the changes to create the doxydoc for product lsst_distrib. The devenv/lsstDoxygen/bin/makedocs tool currently is restricted to building the documentation for a *single* product; it includes all of that product's dependencies.
However, the Release aggregator: lsst_distrib, does not include obs_cfht nor obs_subaru. I believe that obs_cfht was removed as a Release artifact due to its decrepitude. I suspect that obs_subaru isn't a DM Release artifact for other reasons.
So I will update the BB doxydoc generation to build the lsst_distrib product. I will also cleanup a handful of dependencies which should be excluded from consideration and are causing exceptions during doxydoc processing (i.e., the new sims externals: scisql, mysqlpython, ...).
I might even look into moving the huge doxydoc generation log to the side since it is serving no purpose other than causing me to scroll beyond it to determine what happened during the final sanity check test.