NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI · #3720 most downloaded on PyPI
A sphinx extension that automatically documents argparse commands and options
Last release 1 months ago
21 Aug 2026
Release timing varies
gaps range from 5 weeks to 2.8 years
Nearly every release is documented
notes for 30 of 32 stable releases
Nothing withdrawn
no release was ever pulled
13 years old
32 releases · first in 2013
Add missing domain methods by @BrennanGit in #99
Full Changelog: v0.6.0...v0.6.1
#98 Fixed issue where a parallel sphinx build would fail (mostly relevant in CI)
Added default feature to disable ArgumentParser coloring by @RobertoRoos in #74
One column per quarter.
parse_parser to fix subparsers by @RobertoRoos in #84Full Changelog: v0.5.2...v0.6.0
parse_parser to fix subparsers by @RobertoRoos in https://github.com/sphinx-doc/sphinx-argparse/pull/84Full Changelog: https://github.com/sphinx-doc/sphinx-argparse/compare/v0.5.2...v0.6.0
The following enhancements to the HTML output are described on the Basic usage page.
Optional command index.
Optional :index-groups: field to the directive for an command-by-group index.
A sphinxarg_full_subcommand_name option to print fully-qualified sub-command headings. This option helps when more than one sub-command offers a create or list or other repeated sub-command.
Each command heading is a domain-specific link target.
You can link to commands and sub-commands with the :ref: role, but this
release adds support for the domain-specific role like :commands:command:sample-directive-opts A . The :commands:command: role supports linking from other projects through the
intersphinx extension.
Changes
Previously, common headings such as Positional Arguments were subject to a process that made them unique by adding a _repeatX suffix to the HREF target. This release continues to support those HREF targets as secondary targets so that bookmarks continue to work. However, this release prefers using fully-qualified HREF targets like sample-directive-opts-positional-arguments as the primary HREF so that customers are less likely to witness the _repeatX link in URLs.
#32 Argparse commands are now part of a Sphinx domain
#72 Coloring in argparse output can be disabled (default)
#87 The :filename: input is now resolved only to the conf.py directory ( srcdir in Sphinx)
#89 Changed the way mock from autodoc is important to work around a persistent Sphinx bug
Full Changelog : https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1
Fix formatting of empty-string default values. Patch by Adam Turner.
Full Changelog: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1
Full Changelog: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1
Fix autodoc_mock_imports support. Patch by Adam Turner.
Properly declare supported Sphinx and Docutils versions. Patch by Adam Turner.
Fix tests and ensure tests run in CI. Patch by Adam Turner.
Detect pre-release for GH release from python code by @ashb in #28
autodoc_mock_imports by @prajeeshag in #35Full Changelog: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1
autodoc_mock_imports by @prajeeshag in https://github.com/sphinx-doc/sphinx-argparse/pull/35Full Changelog: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1
Add HTML tests to avoid regressions. Patch by Mike McKiernan in https://github.com/sphinx-doc/sphinx-argparse/pull/33
Escape reStructuredText special characters in the default value. Patch by Robert Roos.
Fix the options formatter for manpages. Patch by Felix Moessbauer in https://github.com/sphinx-doc/sphinx-argparse/pull/50
Handle None return from shutil.which() . Patch by Om Vats in https://github.com/sphinx-doc/sphinx-argparse/pull/52
Drop support for Python 3.7, 3.8, and 3.9. Patch by Adam Turner.
Adopt Flit for packaging. Patch by Adam Turner.
Make argument and option section IDs more unique. Patch by David Hoese in https://github.com/sphinx-doc/sphinx-argparse/pull/44
Fix cases where a suppressed default was visible. Patch by Michele Riva in https://github.com/sphinx-doc/sphinx-argparse/pull/53
Support autodoc_mock_imports . Patch by Adam Turner and Prajeesh Ag in https://github.com/sphinx-doc/sphinx-argparse/pull/35
Fix anchor for toc by @Blaok in #2
Full Changelog: 0.3.2...v0.4.0
Minimum python version is now 3.7 by @ashb in https://github.com/sphinx-doc/sphinx-argparse/pull/25
Fix anchor for toc by @Blaok in https://github.com/sphinx-doc/sphinx-argparse/pull/2
feat: find executable filename to address #16 by @tsutterley in https://github.com/sphinx-doc/sphinx-argparse/pull/17
Test against python 3.11 too by @ashb in https://github.com/sphinx-doc/sphinx-argparse/pull/22
Modernize project: Py3.6+, black, flynt, flake8, Github Actions by @ashb in #1
Modernize project: Py3.6+, black, flynt, flake8, Github Actions by @ashb in #1
Fix tests for python-3.10 and add 3.10 to CI matrix by @mikelolasagasti in #3
Update install.rst by @marimeireles in #12
@mikelolasagasti made their first contribution in #3
@marimeireles made their first contribution in #12
Full Changelog: 0.3.1...0.3.2
- Include tests in sdist
Include tests in sdist
Switch to poetry for building dists
Switch to poetry for building dists
First release from ashb/sphinx-argparse
Declare that parallel builds are supported ( issue #105 ).
- A more verbose error message is now printed if there’s an issue during importing a script (issue #102).
A more verbose error message is now printed if there’s an issue during importing a script (issue #102).
- Various bug fixes and documentation updates.
Various bug fixes and documentation updates.
- Fixed a variety of issues, such as with @replace (issue #99). Thanks to @evgeni
Fixed a variety of issues, such as with @replace (issue #99). Thanks to @evgeni
You can now skip sections with @skip . Thanks to @evgeni
Fixed handling of the epilog
- CommonMark is now only imported if absolutely required. This should fix failures on read the docs. Thanks to @Chilipp for fixing this!
CommonMark is now only imported if absolutely required. This should fix failures on read the docs. Thanks to @Chilipp for fixing this!
- Stopped importing sphinx.util.compat , which was causing issues like that seen in #65
Stopped importing sphinx.util.compat , which was causing issues like that seen in #65
- Section titles can now be used in tables of contents and linked to. The title itself is also used as the anchor. In the case of repeated names _repl
Section titles can now be used in tables of contents and linked to. The title itself is also used as the anchor. In the case of repeated names _replicateX , where X is a number, is prepended to ensure that all titles are uniquely linkable. This was bug #46 .
The positional (aka required) and named (aka optional) option sections are now named “Positional Arguments” and “Named Arguments”, for the sake of clarity (e.g., named arguments can be required). This was issue #58 .
Fixed quoting of default strings (issue #59 ).
Added the :noepilog: and :nodescription: options, thanks to @arewm.
Added the :nosubcommand: option, thanks to @arewm.
- Fixed handling of argument groups (this was bug #49 ). Thanks to @croth1 for reporting this bug. Note that now position arguments (also known as req
Fixed handling of argument groups (this was bug #49 ). Thanks to @croth1 for reporting this bug. Note that now position arguments (also known as required arguments) within argument groups are now also handled correctly.
- Added a :nodefaultconst: directive, which is similar to the :nodefault: directive, but applies only to store_true , store_false , and store_const (e
Added a :nodefaultconst: directive, which is similar to the :nodefault: directive, but applies only to store_true , store_false , and store_const (e.g., it will hide the “=True” part in the output, since that can be misleading to users).
Fixed various typos (thanks to users mikeantonacci, brondsem, and tony)
Format specifiers (e.g., %(prog)s and %(default)s ) are now filled in (if possible) in help sections. If there’s a missing keyword, then nothing will be filled in. This was issue #27.
The package is now a bit more robust to incorrectly spelling module names (#39, courtesy of Gabriel Falcão)
Added support for argparse groups (thanks to Fidel Ramirez)
- Fixed malformed docutils DOM in manpages (Matt Boyer)
Fixed malformed docutils DOM in manpages (Matt Boyer)
- Support for aliasing arguments #22 (Campbell Barton)
Support for aliasing arguments #22 (Campbell Barton)
Support for nested arguments #23 (Campbell Barton)
Support for subcommand descriptions #24 (Campbell Barton)
Improved parsing of content of epilog and description #25 (Louis - https://github.com/paternal )
Added ‘passparser’ option (David Hoese)
- Bugfix: Choices are not always strings (Robert Langlois)
Bugfix: Choices are not always strings (Robert Langlois)
Polished small mistakes in usage documentation (Dean Malmgren)
Started to improve man-pages support (Zygmunt Krynicki)
- Improved error reporting (James Anderson)
Improved error reporting (James Anderson)
- Fixed stupid bug, prevented things working on py3 (Alex Rudakov)
Fixed stupid bug, prevented things working on py3 (Alex Rudakov)
added tox configuration for tests
- Remove the ugly new line in the end of usage string (Vadim Markovtsev)
Remove the ugly new line in the end of usage string (Vadim Markovtsev)
Issue #9 Display argument choises (Proposed by Felix-neko, done by Alex Rudakov)
ref : syntax for specifying path to parser instance. Issue #7 (Proposed by David Cottrell, Implemented by Alex Rudakov)
Updated docs to read the docs theme
Fix problem with python version comparison, when python reports it as “2.7.5+” (Alex Rudakov)
Fix problem with python version comparison, when python reports it as “2.7.5+” (Alex Rudakov)
Argparse is not required anymore separate module as of python 2.7 (Mike Gleen)
Argparse is not required anymore separate module as of python 2.7 (Mike Gleen)
Adding :nodefault: directive that skips default values for options (Stephen Tridgell)
Adding :nodefault: directive that skips default values for options (Stephen Tridgell)
Fix issue: epilog is ignored (James Anderson - https://github.com/jamesra )
Fix issue: epilog is ignored (James Anderson - https://github.com/jamesra )
Fix issue #3: ==SUPPRESS== in option list with no default value
Fix issue #3: ==SUPPRESS== in option list with no default value
Nothing published for this version
Fix issue with subcommands (by Tony Narlock - https://github.com/tony )
Fix issue with subcommands (by Tony Narlock - https://github.com/tony )
Initial version On this page - Change log - 0.6.1 - 0.6.0 - 0.5.2 - 0.5.1 - 0.5.0 - 0.4.0 - 0.3.1 - 0.3.0 - 0.2.5 - 0.2.4 - 0.2.3 - 0.2.2 - 0.2.1 - 0.
Initial version
On this page
Change log
0.6.1
0.6.0
0.5.2
0.5.1
0.5.0
0.4.0
0.3.1
0.3.0
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.17
0.1.16
0.1.15
0.1.14
0.1.13
0.1.12
0.1.11
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.2
0.1.1
Nothing published for this version
Your coding agent can read these notes before it upgrades. Set up the MCP server →