sphinx-argparse-cli 1.1.0

render CLI arguments (sub-commands friendly) defined by argparse module

sphinx-argparse-cli

Render CLI arguments (sub-commands friendly) defined by the argparse module.

Demo projects:

• tox

installation

python -m pip install sphinx-argparse-cli

enable in your conf.py

# just add it to your list of extensions to load within conf.py
extensions = ["sphinx_argparse_cli"]

use

Within the reStructuredText files use the sphinx_argparse_cli directive that takes two arguments:

• the module path to where the parser is defined,
• a no argument function within that module that once called returns the constructed argparse parser
• (optional) a program name that overwrites the autodiscovered running argument parser

.. sphinx_argparse_cli::
  :module: a_project.cli
  :func: build_parser
  :prog: my-cli-program