sphinx-argparse
0.1.15
  • Installation
  • Basic usage
  • Other useful directives
  • Extending result of argparse directive
  • Examples
  • Contribution
sphinx-argparse
  • Docs »
  • sphinx-argparse
  • View page source

sphinx-argparse¶

sphinx-argparse is extension for sphinx that allows easily generate documentation for command line tools based on argparse library.

  • Installation
  • Basic usage
  • Other useful directives
  • Extending result of argparse directive
  • Examples
    • Example structure of pages
    • Source of example file
    • Generated sample 1 - command with subcommands
    • Generated sample 2 - subcommand
  • Contribution

References¶

Similar projects¶

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

© Copyright 2017, Alex Rudakov.

Built with Sphinx using a theme provided by Read the Docs.