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

pex_config numpydoc conversion and package documentation configuration

    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

            Hide
            jsick Jonathan Sick added a comment -

            When implementing this ticket, also improve and cross-link in the lsst.pipe.base "Configuring command-line tasks" and "Retargeting subtasks of command-line tasks" topics. See comments in pipe_base PR https://github.com/lsst/pipe_base/pull/37

            Show
            jsick Jonathan Sick added a comment - When implementing this ticket, also improve and cross-link in the lsst.pipe.base "Configuring command-line tasks" and "Retargeting subtasks of command-line tasks" topics. See comments in pipe_base PR https://github.com/lsst/pipe_base/pull/37
            Show
            jsick Jonathan Sick added a comment - Specifically: https://github.com/lsst/pipe_base/pull/37/files#diff-7be10bd28b721e80b8ced2d45c26d119
            Hide
            jsick Jonathan Sick added a comment -

            I've now got a rendered site with the pex_config documentation site attached as pex_config-v1.zip.

            Show
            jsick Jonathan Sick added a comment - I've now got a rendered site with the pex_config documentation site attached as pex_config-v1.zip .
            Hide
            jbosch Jim Bosch added a comment -

            Looks very nice, overall.  I reviewed by just reading the built HTML in its entirety, and only commented on / looked at the diff when I found issues there.  That means I haven't paid much attention to distinguishing between new and preexisting issues, but hopefully it'll mostly be relevant.

            Show
            jbosch Jim Bosch added a comment - Looks very nice, overall.  I reviewed by just reading the built HTML in its entirety, and only commented on / looked at the diff when I found issues there.  That means I haven't paid much attention to distinguishing between new and preexisting issues, but hopefully it'll mostly be relevant.
            Hide
            jsick Jonathan Sick added a comment -

            Merged. Thanks for the very helpful comments. I've added linked tickets to improve the user guide.

            Show
            jsick Jonathan Sick added a comment - Merged. Thanks for the very helpful comments. I've added linked tickets to improve the user guide.

              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