render CLI arguments (sub-commands friendly) defined by argparse module
Project description
sphinx-argparse-cli
Render CLI arguments (sub-commands friendly) defined by the argparse module.
Demo projects:
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
.. sphinx_argparse_cli::
:module: a_project.cli
:func: build_parser
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx_argparse_cli-1.0.0.tar.gz
(12.8 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_argparse_cli-1.0.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e6f3f6547ec72d6b3e6edafa1c38f7900e00b676947e09a941af87e576908c28 |
|
| MD5 | 5bcbbcebae7c28c83a780b081df52b3f |
|
| BLAKE2b-256 | f644905b8245bbdfbb31a2f7fb68925a1c3cbfa9844930eb9f92ab6fb37c4623 |
Close
Hashes for sphinx_argparse_cli-1.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 095e93e60a87cfdd8b770229058b06bdd157166d7c9f429be2baa80ef0e1bee1 |
|
| MD5 | 5e836dc998b5424dcf1ffdd63800a4ff |
|
| BLAKE2b-256 | b6ff5282227cb36f0297543828b99ad536fc20f3174fbcf186a5bf23f447ca9e |
