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

          Activity

            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).

            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).

            This feature will become available in documenteer 0.5.2+

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

            People

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

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.