sphinx-click

sphinx-click is a Sphinx plugin that allows you to automatically extract documentation from a click-based application and include it in your docs.

• Installation
• Usage
  • .. click::
  • Cross-referencing
  • Docstring processing
  • Example
  • Modifying sys.path
• Contribution
  • Support
  • Reporting Issues
  • Submitting Patches
  • Testing
• Changes
  • 5.0.0
  • 4.4.0
  • 4.3.0
  • 4.2.0
  • 4.1.0
  • 4.0.3
  • 4.0.2
  • 4.0.1
  • 4.0.0
• Examples
  • Documenting commands
  • Documenting groups
  • Documenting command collections

See also

Module click

This extension assumes you are using click to create your command line application.

Module sphinxcontrib.autoprogram

An equivalent library for use with argparse.