sphinx-argparse
A sphinx extension that automatically documents argparse commands and options
Why this rank:Strong adoptionRecent releaseHealthy release cadence
Description
================= sphinx-argparse ================= .. image:: https://img.shields.io/pypi/v/sphinx-argparse.svg :target: https://pypi.org/project/sphinx-argparse/ :alt: PyPI version .. image:: https://img.shields.io/conda/vn/conda-forge/sphinx-argparse.svg :target: https://github.com/conda-forge/sphinx-argparse-feedstock/ :alt: Conda version .. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg :target: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml :alt: Build Status .. image:: https://readthedocs.org/projects/sphinx-argparse/badge/?version=stable :target: https://sphinx-argparse.readthedocs.org/ :alt: Documentation Status .. image:: https://img.shields.io/badge/License-MIT-blue.svg :target: https://opensource.org/licenses/MIT :alt: MIT A Sphinx extension to automatically document argparse_ commands and options. For installation and usage details see the documentation_. The changelog is also `found there`_. .. _argparse: https://docs.python.org/3/library/argparse.html .. _documentation: https://sphinx-argparse.readthedocs.org/ .. _found there: https://sphinx-argparse.readthedocs.org/en/latest/changelog.html .. note:: This project used to live at `alex-rudakov/sphinx-argparse`_, and has been revived and moved to this `new home`_. .. _alex-rudakov/sphinx-argparse: https://github.com/alex-rudakov/sphinx-argparse/ .. _new home: https://github.com/sphinx-doc/sphinx-argparse/
Release History
| Version | Changes | Urgency | Date |
|---|---|---|---|
| v0.6.1 | ## What's Changed * Add missing domain methods by @BrennanGit in https://github.com/sphinx-doc/sphinx-argparse/pull/99 ## New Contributors * @BrennanGit made their first contribution in https://github.com/sphinx-doc/sphinx-argparse/pull/99 **Full Changelog**: https://github.com/sphinx-doc/sphinx-argparse/compare/v0.6.0...v0.6.1 | High | 8/21/2026 |
| v0.6.0 | ## What's Changed * Added default feature to disable ArgumentParser coloring by @RobertoRoos in https://github.com/sphinx-doc/sphinx-argparse/pull/74 * Trying to fix RTD refusing to build by @RobertoRoos in https://github.com/sphinx-doc/sphinx-argparse/pull/77 * Moved color-disabling into `parse_parser` to fix subparsers by @RobertoRoos in https://github.com/sphinx-doc/sphinx-argparse/pull/84 * Unpinned ruff for CI + Cleaned up workflow files a little by @RobertoRoos in https://github.com/sphinx | High | 7/1/2026 |
| 0.5.2 | Imported from PyPI (0.5.2) | Low | 4/21/2026 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.2 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.1 | **Full Changelog**: https://sphinx-argparse.readthedocs.io/en/latest/changelog.html#id1 | Low | 7/17/2024 |
| v0.5.0 | ## What's Changed * Detect pre-release for GH release from python code by @ashb in https://github.com/sphinx-doc/sphinx-argparse/pull/28 * Update dev/lint deps to more recent versions by @ashb in https://github.com/sphinx-doc/sphinx-argparse/pull/29 * Add HTML tests to avoid regressions by @mikemckiernan in https://github.com/sphinx-doc/sphinx-argparse/pull/33 * Fix link to github repo in docs Contribute page by @tcompa in https://github.com/sphinx-doc/sphinx-argparse/pull/30 * Added escape | Low | 7/15/2024 |
| v0.4.0 | ## What's Changed * Fix anchor for toc by @Blaok in https://github.com/ashb/sphinx-argparse/pull/2 * Minimum python version is now 3.7 by @ashb in https://github.com/ashb/sphinx-argparse/pull/25 * Update linters by @ashb in https://github.com/ashb/sphinx-argparse/pull/24 * Modern readthedocs config by @ashb in https://github.com/ashb/sphinx-argparse/pull/23 * feat: find executable filename to address #16 by @tsutterley in https://github.com/ashb/sphinx-argparse/pull/17 * Test against pytho | Low | 11/11/2022 |
| 0.3.2 | ## What's Changed * Modernize project: Py3.6+, black, flynt, flake8, Github Actions by @ashb in https://github.com/ashb/sphinx-argparse/pull/1 * Fix tests for python-3.10 and add 3.10 to CI matrix by @mikelolasagasti in https://github.com/ashb/sphinx-argparse/pull/3 * Update install.rst by @marimeireles in https://github.com/ashb/sphinx-argparse/pull/12 * @mikelolasagasti made their first contribution in https://github.com/ashb/sphinx-argparse/pull/3 * @marimeireles made their first con | Low | 10/3/2022 |
| 0.3.1 | Release 0.3.1 | Low | 9/6/2021 |
Dependencies & License Audit
Loading dependencies...
Similar Packages
More from pypi
markitdownUtility tool for converting various files to Markdown
fastapiFastAPI framework, high performance, easy to learn, fast to code, ready for production
djangoA high-level Python web framework that encourages rapid development and clean, pragmatic design.
flaskA simple framework for building complex web applications.
More in Frameworks
onnxruntimeONNX Runtime: cross-platform, high performance ML inferencing and training accelerator
bamlThe AI framework that adds the engineering to prompt engineering (Python/TS/Ruby/Java/C#/Rust/Go compatible)
pyodpsODPS Python SDK and data analysis framework
DrasilGenerate all the things (focusing on research software)