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

Add sphinx-argparse to documenteer[pipelines]

    XMLWordPrintable

    Details

      Description

      Add sphinx-argparse to the documenteer[pipelines] dependency list to enable auto documentation of argparse-based scripts.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-20768 Create script documentation pages for lsst.verify

          • 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

            Activity

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

            After some experimentation, I realized that sphinxcontrib.autoprogram actually works better than sphinx-argparse. It uses the native program and option directives to mark up the command line interface, which lets us do standard cross-references to command line options. It also renders better (definition lists rather than tables).

            Show
            jsick Jonathan Sick added a comment - After some experimentation, I realized that sphinxcontrib.autoprogram actually works better than sphinx-argparse . It uses the native program and option directives to mark up the command line interface, which lets us do standard cross-references to command line options. It also renders better (definition lists rather than tables).
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            This feature will become available in documenteer 0.5.2+

            Show
            jsick Jonathan Sick added a comment - This feature will become available in documenteer 0.5.2+

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.