Details
-
Type:
Story
-
Status: To Do
-
Resolution: Unresolved
-
Fix Version/s: None
-
Component/s: Continuous Integration
-
Labels:
-
Team:SQuaRE
Description
This issue is focused on simplifying the users' web front-end to the doxygen documentation associated with specific builds. In particular:
- restructure the public website to simplify users' ability to find the document version they are seeking. This might be by mapping to a bNNN, date or Release tag.
- on each 'official' DM Release, capture the doxygen documentation under the name of the Release.
Attachments
Issue Links
Activity
| Field | Original Value | New Value |
|---|---|---|
| Labels | DevOps |
| Team | SQuaRE [ 10302 ] |
| Assignee | Robyn Allsman [ robyn ] | Frossie Economou [ frossie ] |
| Remote Link | This issue links to "Page (Confluence)" [ 19764 ] |
It looks like pipelines.lsst.io for v17 will link to the corresponding Doxygen documentation. We might quibble about exactly the positioning of that link, but I think that's a big step forward.
It'd be even better if each daily of pipelines.lsst.io could link to corresponding daily Doxygen, but I suspect that isn't straightforward (the Doxygen builds are only timestamped and not otherwise tagged as far as I know). I guess even just linking to the most recent timestamp at the time pipelines.lsst.io was built would be neat.
Yes, see DM-996 for linking the 17.0 release to the corresponding Doxygen documentation.
pipelines.lsst.io already links to the 'master' build of doxygen (https://pipelines.lsst.io/v/daily/index.html#more-info). Writing some fancy code to look up the current Doxygen build URL corresponding to a given pipelines.lsst.io build is certainly possible, but I can forsee some complications that would make this a "high effort, low benefit" feature.
I'd honestly recommend that we prioritize including the Doxygen content in the Sphinx build so we can deprecate the Doxygen site altogether. I'd consider this a sensible next step in the development of https://pipelines.lsst.io given where we're at now.
pipelines.lsst.io already links to the 'master' build of doxygen (https://pipelines.lsst.io/v/daily/index.html#more-info)
Hmm, we should change the wording of this, I guess — much of the API documentation is coming through Sphinx, not Doxgen.
| Remote Link | This issue links to "Page (Confluence)" [ 34536 ] |
Should we close this as won't fix? We are even more into sphinx now and presumably a plan for doxygen integration in pipelines.lsst.io for official releases is on a separate ticket.
I'd like to deprecate the doxygen site, but we're not quite there yet. Unfortunately, it looks like plumbing the eups release tag (v*, w_*, or d_*) through to the doxygen site generation or even to the aws cp command used to upload the site is somewhat difficult. It would be relatively easy to include the build number (bNNNN) in the site path, as suggested in the first bullet, but it's not clear that that's very useful.
So this ticket still seems useful for a while longer but not trivial to implement, and so it continues to be deprioritized.
Frossie Economou, Jonathan Sick, maybe this ticket has been superseded by the work on pipelines.lsst.io?