Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-1044

Restructure the user facing site containing the doxygen documentation

    Details

    • 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

            Hide
            tjenness Tim Jenness added a comment -

            Frossie Economou, Jonathan Sick, maybe this ticket has been superseded by the work on pipelines.lsst.io?

            Show
            tjenness Tim Jenness added a comment - Frossie Economou , Jonathan Sick , maybe this ticket has been superseded by the work on pipelines.lsst.io?
            Hide
            swinbank John Swinbank added a comment -

            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.

            Show
            swinbank John Swinbank added a comment - 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.
            Hide
            jsick Jonathan Sick added a comment -

            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.

            Show
            jsick Jonathan Sick added a comment - 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.
            Hide
            swinbank John Swinbank added a comment -

            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.

            Show
            swinbank John Swinbank added a comment - 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.

              People

              • Assignee:
                frossie Frossie Economou
                Reporter:
                robyn Robyn Allsman [X] (Inactive)
                Watchers:
                John Swinbank, Jonathan Sick, Robyn Allsman [X] (Inactive), Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel