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

Trial generating C++ documentation for pipelines.lsst.io using Breathe's breathe-apidoc tool

    XMLWordPrintable

    Details

      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 breathe-apidoc, a CLI tool that's part of Breathe. This ticket is to demo that approach and see if it's an appropriate solution for the LSST Science Pipelines documentation.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-22500 Trial generating C++ documentation for pipelines.lsst.io using "exhale"

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-23094 Implement C++ reference documentation for pipelines.lsst.io using "Doxylink"

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-22461 Create Sphinx "autocppapi" extension in Documenteer

          • Done

            Activity

            Ascending order - Click to sort in descending order
            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 -
            Link This issue relates to DM-22461 [ DM-22461 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-22500 [ DM-22500 ]
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Story Points 0.7
            jsick Jonathan Sick made changes -
            Story Points 0.7 2.4
            jsick Jonathan Sick made changes -
            Attachment DM-22499-pipelines_lsst_io.txt [ 42216 ]
            jsick Jonathan Sick made changes -
            Attachment DM-22499-documenteer.txt [ 42217 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-23094 [ DM-23094 ]
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status In Progress [ 3 ] Done [ 10002 ]

              People

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

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.