Metadata-Version: 2.4
Name: sphinx-autodoc-argparse
Version: 0.0.1a13
Summary: Modern Sphinx extension for documenting argparse-based CLI tools
Project-URL: Repository, https://github.com/git-pull/gp-sphinx
Author-email: Tony Narlock <tony@git-pull.com>
License: MIT
Keywords: argparse,cli,documentation,sphinx
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Domain
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Classifier: Typing :: Typed
Requires-Python: <4.0,>=3.10
Requires-Dist: docutils
Requires-Dist: pygments
Requires-Dist: sphinx>=8.1
Description-Content-Type: text/markdown

# 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.mock` dependency)
- 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

```console
$ pip install sphinx-autodoc-argparse
```

## Usage

In your `docs/conf.py`:

```python
extensions = ["sphinx_autodoc_argparse"]
```

Then use the `.. argparse::` directive:

```rst
.. argparse::
   :module: myapp.cli
   :func: create_parser
   :prog: myapp
```
