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

Initial Sphinx docs for pipe_base

    Details

      Description

      Initial documentation set for pipe_base in the https://dmtn-030.lsst.io architecture. Includes converting existing content found in DM-10639.

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -

            Focus so far is on creating a command line task argument/syntax reference and usage how-tos.

            Show
            jsick Jonathan Sick added a comment - Focus so far is on creating a command line task argument/syntax reference and usage how-tos.
            Hide
            jsick Jonathan Sick added a comment -

            Robert Lupton, could you review the new pex_config documentation, primarily around the command-line user documentation?

            We're especially looking for your guidance on the "Using command-line task" how-to documentation, and what workflows should be featured in the documentation (considered idiomatic) or discouraged.

            Note that the following pages are from the original Doxygen and haven't been changed yet, other than being ported to reStructuredText:

            We'll get these pages in a later ticket.

            Show
            jsick Jonathan Sick added a comment - Robert Lupton , could you review the new pex_config documentation, primarily around the command-line user documentation? PR: https://github.com/lsst/pipe_base/pull/37 Draft: https://pipelines.lsst.io/v/DM-11253/modules/lsst.pipe.base/index.html We're especially looking for your guidance on the "Using command-line task" how-to documentation, and what workflows should be featured in the documentation (considered idiomatic) or discouraged. Note that the following pages are from the original Doxygen and haven't been changed yet, other than being ported to reStructuredText: Overview of the task framework: https://pipelines.lsst.io/v/DM-11253/modules/lsst.pipe.base/task-framework-overview.html Creating a task: https://pipelines.lsst.io/v/DM-11253/modules/lsst.pipe.base/creating-a-task.html Creating a command-line task: https://pipelines.lsst.io/v/DM-11253/modules/lsst.pipe.base/creating-a-command-line-task.html We'll get these pages in a later ticket.
            Hide
            jsick Jonathan Sick added a comment -

            Thank you Robert Lupton, and others, for your comments. I've incorporated all changes that can be made in this ticket.

            I've also created follow-on tickets for future work that is needed to implement many of the suggestions in the PR.

            • Regarding -output, -rerun, PIPE_INPUT_ROOT, someone from the Science Pipelines team can go ahead and RFC deprecations. I've created DM-11685 to implement doc changes that fall out from that RFC, and to generally research and document opinionated strategies on using Butler repositories.
            • DM-11673 to improve the "creating a task" topic, which is currently the same as in Doxygen.
            • DM-11674 to improve the "creating a command-line task" topic, which is currently the same as in Doxygen.
            • DM-11694 to improve the overview topic, which is currently nearly the same in Doxygen.
            • DM-11687 to research and add --show history documentation, which I missed in this initial work.
            • DM-11675 to port and cross-link the debug framework documentation from Doxygen.
            • DM-11558 to create pex_config documentation, which will especially help the re-targeting docs (the re-targeting docs in this ticket are ports from Doxygen but certainly need work to clarify).
            • DM-11671 to create Butler/daf_persistence documentation
            Show
            jsick Jonathan Sick added a comment - Thank you Robert Lupton , and others, for your comments. I've incorporated all changes that can be made in this ticket. I've also created follow-on tickets for future work that is needed to implement many of the suggestions in the PR. Regarding - output , -rerun , PIPE_INPUT_ROOT , someone from the Science Pipelines team can go ahead and RFC deprecations. I've created DM-11685 to implement doc changes that fall out from that RFC, and to generally research and document opinionated strategies on using Butler repositories. DM-11673 to improve the "creating a task" topic, which is currently the same as in Doxygen. DM-11674 to improve the "creating a command-line task" topic, which is currently the same as in Doxygen. DM-11694 to improve the overview topic, which is currently nearly the same in Doxygen. DM-11687 to research and add --show history documentation, which I missed in this initial work. DM-11675 to port and cross-link the debug framework documentation from Doxygen. DM-11558 to create pex_config documentation, which will especially help the re-targeting docs (the re-targeting docs in this ticket are ports from Doxygen but certainly need work to clarify). DM-11671 to create Butler/ daf_persistence documentation

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Reviewers:
                Robert Lupton
                Watchers:
                Jonathan Sick, Robert Lupton
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel