Documenting CLI programs
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
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:
Mar 13, 2024
0.1.9
Mar 13, 2024
0.1.9rc1
Feb 11, 2023
0.1.8
Feb 10, 2021
0.1.7
May 15, 2018
0.1.5
Feb 27, 2018
0.1.4
Oct 06, 2016
0.1.3
Aug 18, 2015
0.1.2
Apr 22, 2014
0.1.1
Mar 02, 2014
0.1.0
Wheel compatibility matrix
Files in release
Extras:
None
Dependencies:
(>=1.2)
Sphinx