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

Create script documentation pages for lsst.verify

    XMLWordPrintable

    Details

      Description

      As a proof-of-concept for documenting ad hoc command line utilities, create documentation pages for the scripts that ship with https://github.com/lsst/verify. This will use the sphinx-argparse extension being added to documenteer (DM-20767)

      See https://sqr-032.lsst.io for more details about documenting scripts for the LSST stack (DM-20511).

        Attachments

          Issue Links

          is triggered by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-20511 Analyze and expand on requirements for documentation examples and testing from DMTN-085 in SQR-032 technote

          • Done
          relates to

          Bug - A problem which impairs or prevents the functions of the product. DM-20963 inspect_job.py broken

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-20821 Create and document a template for ad hoc script documentation

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-20767 Add sphinx-argparse to documenteer[pipelines]

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            See PR https://github.com/lsst/verify/pull/45 (which links to rendered drafts of these docs).

            Show
            jsick Jonathan Sick added a comment - See PR https://github.com/lsst/verify/pull/45 (which links to rendered drafts of these docs).
            Hide
            Permalink
            krughoff Simon Krughoff added a comment -

            See three small comments in PR.

            Show
            krughoff Simon Krughoff added a comment - See three small comments in PR.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Thanks Simon Krughoff!

            Show
            jsick Jonathan Sick added a comment - Thanks Simon Krughoff !

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              Simon Krughoff
              Watchers:
              Jonathan Sick, Simon Krughoff
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: