Skip to main content

Modern Sphinx extension for documenting argparse-based CLI tools

Project description

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

$ 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_autodoc_argparse-0.0.1a10.tar.gz (42.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_autodoc_argparse-0.0.1a10-py3-none-any.whl (47.3 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_autodoc_argparse-0.0.1a10.tar.gz.

File metadata

File hashes

Hashes for sphinx_autodoc_argparse-0.0.1a10.tar.gz
Algorithm Hash digest
SHA256 91052e40aaef5355cef1ebc3529482286d4a662becf6049b60787c9365b89529
MD5 256247f973cf5db8b8ec54d1ce75fde2
BLAKE2b-256 e467c1ea6958e4e800e9ee26ed703cb0e4b823b2dbea1cf133c9b25cfcf06ff3

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_argparse-0.0.1a10.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_autodoc_argparse-0.0.1a10-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autodoc_argparse-0.0.1a10-py3-none-any.whl
Algorithm Hash digest
SHA256 4c58ba98f245314535cbbe8eff91810590db2c48b4c8dc41226ef28708000f2b
MD5 33e91498c29b7055f506e677175667d4
BLAKE2b-256 8c7310f9f4b2a8e677fc6fe2de3bd84c5f3f55bf24fa8fd2812efd73cca6877e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_argparse-0.0.1a10-py3-none-any.whl:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page