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

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

    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

          Container Issues

            Issue Links

              Activity

                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:

                    Summary Panel