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

Document topic support for pipeline tasks

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: dm_dev_guide, templates
    • Labels:
      None

      Description

      Documenteer has a lsst-pipelinetasks directive that works analogously to lsst-cmdlinetasks. However, it is not mentioned in either the module topic documentation nor in the package templates. As a result, tasks that get converted to PipelineTask will drop off the module documentation.

      Add a lsst-pipelinetasks section to the template (possibly before lsst-cmdlinetasks, which is still relevant until the migration is complete) and update the developer guide to match. Updating the index.rst files of individual packages is out of scope for this issue.

        Attachments

          Activity

          Show
          jsick Jonathan Sick added a comment - Templates PR: https://github.com/lsst/templates/pull/60 Developer Guide PR: https://github.com/lsst-dm/dm_dev_guide/pull/364 and draft: https://developer.lsst.io/v/DM-22520/stack/module-homepage-topic-type.html#task-reference-section
          Hide
          krzys Krzysztof Findeisen added a comment -

          I found the links to the Documenteer docs a bit confusingly presented; otherwise looks good.

          Show
          krzys Krzysztof Findeisen added a comment - I found the links to the Documenteer docs a bit confusingly presented; otherwise looks good.
          Hide
          jsick Jonathan Sick added a comment -

          Thanks for that feedback. I think I've got those addressed in the final merge.

          Show
          jsick Jonathan Sick added a comment - Thanks for that feedback. I think I've got those addressed in the final merge.

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel