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

pex_config numpydoc conversion and package documentation configuration

    XMLWordPrintable

    Details

      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

          Issue Links

            Activity

            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-10635 [ 32584 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-11253 [ DM-11253 ]
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Story Points 1.4 1.8
            jsick Jonathan Sick made changes -
            Epic Link DM-10635 [ 32584 ] DM-5646 [ 23496 ]
            jsick Jonathan Sick made changes -
            Story Points 1.8 2.5
            jsick Jonathan Sick made changes -
            Epic Link DM-5646 [ 23496 ] DM-7500 [ 26629 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-12088 [ DM-12088 ]
            jsick Jonathan Sick made changes -
            Epic Link DM-7500 [ 26629 ] DM-12790 [ 36408 ]
            jsick Jonathan Sick made changes -
            Remote Link This issue links to "Page (Confluence)" [ 16777 ]
            jsick Jonathan Sick made changes -
            Epic Link DM-12790 [ 36408 ] DM-14522 [ 86285 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-15472 [ DM-15472 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-15489 [ DM-15489 ]
            swinbank John Swinbank made changes -
            Component/s pex_config [ 10729 ]
            swinbank John Swinbank made changes -
            Risk Score 0
            swinbank John Swinbank made changes -
            Labels pipelines-docs numpydoc pipelines-docs
            swinbank John Swinbank made changes -
            Link This issue relates to DM-15347 [ DM-15347 ]
            jsick Jonathan Sick made changes -
            Epic Link DM-14522 [ 86285 ] DM-5646 [ 23496 ]
            jsick Jonathan Sick made changes -
            Attachment pex_config-v1.zip [ 36366 ]
            jsick Jonathan Sick made changes -
            Story Points 2.5 7.9
            jsick Jonathan Sick made changes -
            Reviewers Jim Bosch [ jbosch ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            jbosch Jim Bosch made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            jsick Jonathan Sick made changes -
            Epic Link DM-5646 [ 23496 ] DM-16933 [ 238280 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-17196 [ DM-17196 ]
            jsick Jonathan Sick made changes -
            Story Points 7.9 8.9
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]
            tjenness Tim Jenness made changes -
            Link This issue relates to DM-11685 [ DM-11685 ]

              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:

                  Jenkins

                  No builds found.