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

Implement C++ reference documentation for pipelines.lsst.io using "Doxylink"

    XMLWordPrintable

Details

    • Story
    • Status: Done
    • Resolution: Done
    • None
    • documenteer
    • None

    Description

      Investigate using Doxylink to link to an HTML Doxygen build of the C++ API reference compiled alongside the main Sphinx site.

      This work would build upon DM-22698, which gave Documenteer the ability to run a Sphinx build. In this scenario, Documenteer would build the Sphinx site, and then embed it as a sub-site (subdirectory) of the Sphinx-generated documentation. Doxylink would let us link between from reStructuredText to Doxygen using a custom role. For example:

      :lsstcc:`lsst::afw::table::Schema`
      

      Of course, links from Doxygen to the Sphinx site would not be straightforward (in princple, they could be added manually, though that would be prone to fail if URLs change).

      Attachments

        Issue Links

          Activity

            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-21497 [ 424235 ]
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Story Points 1.4
            jsick Jonathan Sick made changes -
            Story Points 1.4 1.8
            jsick Jonathan Sick made changes -
            Description Investigate using "Doxylink" to link to an HTML Doxygen build of the C++ API reference compiled alongside the main Sphinx site. Investigate using [Doxylink|https://sphinxcontrib-doxylink.readthedocs.io/en/stable/] to link to an HTML Doxygen build of the C++ API reference compiled alongside the main Sphinx site.

            This work would build upon DM-22698, which gave Documenteer the ability to run a Sphinx build. In this scenario, Documenteer would build the Sphinx site, and then embed it as a sub-site (subdirectory) of the Sphinx-generated documentation. Doxylink would let us link between from reStructuredText to Doxygen using a custom role. For example:

            {code}
            :lsstcc:`lsst::afw::table::Schema`
            {code}

            Of course, links from Doxygen to the Sphinx site would not be straightforward (in princple, they could be added manually, though that would be prone to fail if URLs change).
            jsick Jonathan Sick made changes -
            Story Points 1.8 2.5
            jsick Jonathan Sick made changes -
            Story Points 2.5 3
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-22499 [ DM-22499 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-22500 [ DM-22500 ]
            jsick Jonathan Sick made changes -
            Story Points 3 5.8
            jsick Jonathan Sick made changes -
            Story Points 5.8 6.8
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status In Progress [ 3 ] Done [ 10002 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-26841 [ DM-26841 ]

            People

              jsick Jonathan Sick
              jsick Jonathan Sick
              Jonathan Sick, Krzysztof Findeisen
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.