sphinx-argparse

sphinx-argparse is an extension for sphinx that allows for easy generation of documentation for command line tools using the python argparse library.

• Installation
• Basic usage
  • About Sub-Commands
  • Other useful directives
  • Printing Fully Qualified Sub-Command Headings
  • Indices
• Extending results of argparse directives
• Examples
  • Example documentation structure
  • Source of example file
  • Generated sample 1 - command with subcommands
  • Generated sample 2 - subcommand
• Miscellaneous
  • Text wrapping in argument tables
  • Linking to action groups
• Markdown
  • Heading 1
  • Sub-commands
  • A note on headers
  • Hard line breaks
  • Replacing/appending/prepending content
  • MarkDown in program descriptions and option help
• Change log
  • 0.5.0
  • 0.4.0
  • 0.3.1
  • 0.3.0
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.17
  • 0.1.16
  • 0.1.15
  • 0.1.14
  • 0.1.13
  • 0.1.12
  • 0.1.11
  • 0.1.10
  • 0.1.9
  • 0.1.8
  • 0.1.7
  • 0.1.6
  • 0.1.5
  • 0.1.4
  • 0.1.2
  • 0.1.1
• Contribute

References

Similar projects

• https://pythonhosted.org/sphinxcontrib-autoprogram/ (See for comparison: https://github.com/ribozz/sphinx-argparse/issues/16)