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

pex_config numpydoc conversion and package documentation configuration

    Details

    • Templates:
    • Story Points:
      8.9
    • Team:
      SQuaRE

      Description

      Initial effort to bring pex_config to the Sphinx-based documentation system.

      This involves:

      • Adding Sphinx documentation infrastructure for packages.
      • Convert docstrings in lsst.pex.config to Numpydoc format to generate an API reference.
      • Port existing user guide content from pex_config to reStructuredText (though fully converting this content into topic-based documentation is not in this scope).

      This is related to DM-11253 for pipe_base.

        Attachments

          Container Issues

            Issue Links

              Activity

                People

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

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Summary Panel