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

Pilot Sphinx/Breath/Doxygen-generated API docs for daf_base

    XMLWordPrintable

    Details

      Description

      Since daf_base is low in the dependency tree and dominated by C++ APIs, it is an excellent candidate for exploring Sphinx-based package documenation for C++ with breathe and doxygen. We will also see how astropy’s automodsumm sphinx extension works with SWIG’d Python APIs.

      This prototype will build upon the system developed in DM-7094.

      Lessons from this prototype will be fed into a "Pipelines Documentation Implementation Planning" tech note in a follow-up ticket.

        Attachments

          Issue Links

            Activity

            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-6199 [ 24715 ]
            jsick Jonathan Sick made changes -
            Link This issue has to be done after DM-7094 [ DM-7094 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-7096 [ DM-7096 ]
            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 2.1
            jsick Jonathan Sick made changes -
            Story Points 2.1 2.3
            jsick Jonathan Sick made changes -
            Story Points 2.3 3
            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
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  CI Builds

                  No builds found.