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

Add support for documenting argparse-based CLIs to documenteer

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: documenteer
    • Labels:
      None

      Description

      Add a Sphinx extension to "autodoc" command line interfaces built with argparse to the documenteer[pipelines] distribution. Options are:

      https://pythonhosted.org/sphinxcontrib-autoprogram/

      https://github.com/ribozz/sphinx-argparse

        Attachments

          Activity

          There are no comments yet on this issue.

            People

            • Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Brian Van Klaveren, Jonathan Sick
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Summary Panel