sphinx-argparse
A sphinx extension that automatically documents argparse commands and options
Decision gist · record as of 2026-08-14
Yes. Low install friction, active maintenance, no known vulnerabilities, permissive MIT license, and a focused purpose that solves a real documentation problem for CLI tools. Install if you use argparse and Sphinx together; skip if you don't use Sphinx or prefer manual CLI documentation.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; your project must use Sphinx and have argparse-based CLI code to document.
- Low friction install with only sphinx and docutils as runtime dependencies.
- Active maintenance with recent release (44 days ago) and continuous repository activity.
License · maintenance · safety
MIT (permissive) — MIT license permits unrestricted use, modification, and distribution in both open and closed projects.
last release 2026-07-01 (44 days) · last repo commit 2026-07-01 · 38 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 4,255,443 downloads/mo, #2,347 on PyPI
Alternatives
Verify before relying
pip install sphinx-argparse
In conf.py:
extensions = ['sphinx_argparse.ext']
In your .rst file:
.. argparse::
:module: mymodule
:func: create_parser- Whether the extension handles complex argparse patterns (subparsers, custom actions, mutually exclusive groups) beyond basic commands.
- Performance characteristics when documenting very large or deeply nested argument hierarchies.
What it is and what it does
sphinx-argparse is a Sphinx extension that bridges the gap between argparse-based command-line tools and their documentation. Instead of manually writing out every argument, option, and subcommand in your docs, you point the extension at your argparse parser object and it automatically generates formatted documentation from the parser's structure. It integrates directly into the Sphinx build process via a custom directive.
The extension depends on sphinx and docutils to render the generated documentation into your final HTML, PDF, or other Sphinx output formats. It's maintained as part of the official Sphinx documentation tooling ecosystem and supports modern Python versions (3.10 through 3.13, including PyPy).
Use it for
- Auto-generate CLI reference documentation from an existing argparse parser without duplicating argument descriptions.
- Keep command-line help text and Sphinx docs in sync by sourcing both from the same parser definition.
- Document complex CLI tools with subcommands and nested argument groups in a structured, searchable format.
- Build API documentation sites that include both Python API and CLI interface reference in one place.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Low install friction, active maintenance, no known vulnerabilities, permissive MIT license, and a focused purpose that solves a real documentation problem for CLI tools. Install if you use argparse and Sphinx together; skip if you don't use Sphinx or prefer manual CLI documentation.
Install
sphinx-argparse on PyPI
Before you install
Low friction install with only sphinx and docutils as runtime dependencies. Active maintenance with recent release (44 days ago) and continuous repository activity.
Requires Python 3.10 or later; your project must use Sphinx and have argparse-based CLI code to document.
License in practice
MIT license permits unrestricted use, modification, and distribution in both open and closed projects.
Quickstart
pip install sphinx-argparse
In conf.py:
extensions = ['sphinx_argparse.ext']
In your .rst file:
.. argparse::
:module: mymodule
:func: create_parserVerify before relying
- Whether the extension handles complex argparse patterns (subparsers, custom actions, mutually exclusive groups) beyond basic commands.
- Performance characteristics when documenting very large or deeply nested argument hierarchies.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagessphinxdocutils |
| Maintenance | Actively maintained 44 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 4,255,443 / month, #2,347 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleFramework :: SphinxFramework :: Sphinx :: ExtensionOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPyTopic :: DocumentationTopic :: Documentation :: Sphinx |
Evidence: sphinx_argparse-0.6.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx argparse documentation”
- sphinx-argparseSphinx extension that automatically generates documentation for…
- entrypoint2Converts Python function signatures and docstrings into command-line…
- mandomando wraps argparse to let you build command-line applications with…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also linuxdoc · sphinxcontrib-devhelp · sphinx-automodapi · sphinxcontrib-qthelp · sphinxcontrib-autoyaml · python-tools-scripts · sphinx-autosummary-accessors · argparse-ext · dargs