sphinxcontrib-autoprogram 0.1.9


pip install sphinxcontrib-autoprogram

  Latest version

Released: Mar 13, 2024

Project Links

Meta
Author: Hong Minhee
Requires Python: >=3.8

Classifiers

Development Status
  • 5 - Production/Stable

Environment
  • Console
  • Web Environment

Framework
  • Sphinx :: Extension

Intended Audience
  • Developers

License
  • OSI Approved :: BSD License

Operating System
  • OS Independent

Programming Language
  • Python
  • Python :: 3.8
  • Python :: 3.9
  • Python :: 3.10
  • Python :: 3.11
  • Python :: 3.12
  • Python :: Implementation :: CPython
  • Python :: Implementation :: Stackless

Topic
  • Documentation
  • Software Development :: Documentation
  • Utilities
Latest PyPI version Documentation Status Build Status

This contrib extension, sphinxcontrib.autoprogram, provides an automated way to document CLI programs. It scans argparse.ArgumentParser object, and then expands it into a set of .. program:: and .. option:: directives.

Install using pip:

$ pip install sphinxcontrib-autoprogram

You can find the documentation from the following URL:

https://sphinxcontrib-autoprogram.readthedocs.io/

Extras: None
Dependencies:
Sphinx (>=1.2)