How to¶
Use this extension when a project needs rendered argparse programs,
options, choices, and role links from the same parser object that powers
its CLI.
Find registered directives and roles¶
The API Reference page lists the directive classes, options, and CLI role callables registered by the extension.
Downstream usage snippets¶
Use native MyST directives in Markdown:
```{argparse}
:module: myproject.cli
:func: create_parser
:prog: myproject
```
Or reStructuredText:
.. argparse::
:module: myproject.cli
:func: create_parser
:prog: myproject
Copyable config snippet
extensions = [
"sphinx_autodoc_argparse",
"sphinx_autodoc_argparse.exemplar",
]