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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_autodoc_argparse-0.1.0a37.tar.gz.
File metadata
- Download URL: sphinx_autodoc_argparse-0.1.0a37.tar.gz
- Upload date:
- Size: 44.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
88fd328552385c7f6f8d3f20ffa6b0a3745386ede13561f045fa91282ef9bcdb
|
|
| MD5 |
70e7a24ac0e1c982867d95984ff81206
|
|
| BLAKE2b-256 |
c3f679584fb0d322917f07459109f49352189767ac75d1786b385134035af938
|
Provenance
The following attestation bundles were made for sphinx_autodoc_argparse-0.1.0a37.tar.gz:
Publisher:
release.yml on git-pull/gp-sphinx
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_autodoc_argparse-0.1.0a37.tar.gz -
Subject digest:
88fd328552385c7f6f8d3f20ffa6b0a3745386ede13561f045fa91282ef9bcdb - Sigstore transparency entry: 2256729506
- Sigstore integration time:
-
Permalink:
git-pull/gp-sphinx@aeb3c6a436c52698f1b9bee97cf48cefb23035b3 -
Branch / Tag:
refs/tags/v0.1.0a37 - Owner: https://github.com/git-pull
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@aeb3c6a436c52698f1b9bee97cf48cefb23035b3 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinx_autodoc_argparse-0.1.0a37-py3-none-any.whl.
File metadata
- Download URL: sphinx_autodoc_argparse-0.1.0a37-py3-none-any.whl
- Upload date:
- Size: 49.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0234e58e75bca9907bb09cc1ce606ed18e2a75e32e4c4b29192a760aaebcbbc4
|
|
| MD5 |
0ef6e6dcdea0122f18ef0e882709bf36
|
|
| BLAKE2b-256 |
b334fe4bed8a6cc826df20355aa6945f50fe70f3936e7365346c0b2445e6afc7
|
Provenance
The following attestation bundles were made for sphinx_autodoc_argparse-0.1.0a37-py3-none-any.whl:
Publisher:
release.yml on git-pull/gp-sphinx
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_autodoc_argparse-0.1.0a37-py3-none-any.whl -
Subject digest:
0234e58e75bca9907bb09cc1ce606ed18e2a75e32e4c4b29192a760aaebcbbc4 - Sigstore transparency entry: 2256729708
- Sigstore integration time:
-
Permalink:
git-pull/gp-sphinx@aeb3c6a436c52698f1b9bee97cf48cefb23035b3 -
Branch / Tag:
refs/tags/v0.1.0a37 - Owner: https://github.com/git-pull
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@aeb3c6a436c52698f1b9bee97cf48cefb23035b3 -
Trigger Event:
push
-
Statement type:
