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

Develop Sphinx configuration for Pipelines Documentation, including MVP HTML/CSS Template

    XMLWordPrintable

    Details

      Description

      This ticket will kick-off a pilot implementation of pipelines documentation in Sphinx. Specific goals are

      1. Develop template for sphinx-ready doc/ directories in packages (based on SQR-006)
      2. Setup a MVP sphinx template that works well with numpydoc and astropy automodsumm. Simply porting astropy’s sphinx template would be pragmatic.
      3. documenteer-driven configuration for sphinx.

      These will be MVPs, and iterated upon in later tickets that implement sphinx API docs for stack packages.

        Attachments

          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:

                  CI Builds

                  No builds found.