https://github.com/sphinx-contrib/autoprogram
Documenting CLI programs
https://github.com/sphinx-contrib/autoprogram
argparse cli sphinx-extension sphinxcontrib
Last synced: about 1 month ago
JSON representation
Documenting CLI programs
- Host: GitHub
- URL: https://github.com/sphinx-contrib/autoprogram
- Owner: sphinx-contrib
- License: other
- Created: 2017-09-28T09:56:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T19:07:32.000Z (about 1 year ago)
- Last Synced: 2025-04-10T03:56:09.126Z (about 1 month ago)
- Topics: argparse, cli, sphinx-extension, sphinxcontrib
- Language: Python
- Homepage: https://pypi.org/project/sphinxcontrib-autoprogram/
- Size: 134 KB
- Stars: 45
- Watchers: 2
- Forks: 24
- Open Issues: 18
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
``sphinxcontrib.autoprogram``
=============================
.. image:: https://badge.fury.io/py/sphinxcontrib-autoprogram.svg
:target: https://pypi.org/project/sphinxcontrib-autoprogram/
:alt: Latest PyPI version
.. image:: https://readthedocs.org/projects/sphinxcontrib-autoprogram/badge/
:target: https://sphinxcontrib-autoprogram.readthedocs.io/
:alt: Documentation Status
.. image:: https://github.com/sphinx-contrib/autoprogram/workflows/Build%20and%20Test/badge.svg?branch=master
:target: https://github.com/sphinx-contrib/autoprogram/actions
:alt: 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``:
.. code-block:: console
$ pip install sphinxcontrib-autoprogram
You can find the documentation from the following URL:
https://sphinxcontrib-autoprogram.readthedocs.io/