This release is a pre-release and may not be stable for production use.
sphinx-autodoc-argparse
Modern Sphinx extension for documenting argparse-based CLI tools.
A modernized replacement for sphinx-argparse that:
- Works with Sphinx 8.x and 9.x (no
autodoc.mockdependency) - Fixes long-standing issues (TOC pollution, heading levels)
- Provides configurable output (rubrics vs sections, flattened subcommands)
- Includes Pygments lexers for argparse help output and CLI usage blocks
- Supports extensibility via renderer classes
Install
$ pip install sphinx-autodoc-argparse
Usage
In your docs/conf.py:
extensions = ["sphinx_autodoc_argparse"]
Then use the .. argparse:: directive:
.. argparse::
:module: myapp.cli
:func: create_parser
:prog: myapp
1 maintainer
Metadata
1 maintainer
Release files for sphinx-autodoc-argparse 0.1.0a38
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_autodoc_argparse-0.1.0a38.tar.gz | 44.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_autodoc_argparse-0.1.0a38-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 93.0 kB
Release files / sphinx_autodoc_argparse-0.1.0a38.tar.gz
| Download URL | sphinx_autodoc_argparse-0.1.0a38.tar.gz |
|---|---|
| Size | 44.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c197495943034222c8bffcdc3de3f30e2b1245f3208bdb939618b2eadec951d5
|
|
BLAKE2b-256 checksum How to use checksums |
d9aced78d77c5f9760ce36c5c79dff4245ced1b3d9f26ff3670ab4d853277b48
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2026.
Transparency logRelease files / sphinx_autodoc_argparse-0.1.0a38-py3-none-any.whl
| Download URL | sphinx_autodoc_argparse-0.1.0a38-py3-none-any.whl |
|---|---|
| Size | 49.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bb0c6702e39faddc6cfe29561971f86eceb34197ac0475def61fa4db32638ac1
|
|
BLAKE2b-256 checksum How to use checksums |
21432c0f582215b648403c5feaca07ae62afb6883b267bab498a744e73468ad8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2026.
Transparency log
