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

Trial generating C++ documentation for pipelines.lsst.io using "exhale"

    Details

    • Templates:
    • Story Points:
      3.9
    • Team:
      SQuaRE

      Description

      To bridge Doxygen-generated C++ reference documentation into pipelines.lsst.io, a Sphinx-based site, we know we want to use Breathe. However, we don't know the best way to build out the API reference site. We don't want a monolithic page with all APIs, instead, we want one-page-per-API, like we do the Python docs.

      One approach to building out this page hierarchy is with exhale, an additional Sphinx extension that builds generates doxygen-like namespace browsing of a C++ API. This ticket is to demo that approach and see if it's an appropriate solution for the LSST Science Pipelines documentation.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Watchers:
                John Parejko, Jonathan Sick, Krzysztof Findeisen
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel