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.1a9.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.1a9-py3-none-any.whl (47.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sphinx_autodoc_argparse-0.0.1a9.tar.gz
Algorithm Hash digest
SHA256 d9004bd8c0b96af930d3d64404362aee78ab04f98dcf309aff42a48d2a0efca0
MD5 460653bf8cfcba49f67f2f2422d2f897
BLAKE2b-256 a235a6a134f9a934dd3969a1461c15b30f6ce44657bf61ab19ce68f17b4effce

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_argparse-0.0.1a9.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.1a9-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autodoc_argparse-0.0.1a9-py3-none-any.whl
Algorithm Hash digest
SHA256 31464f8ec145078fcd22addc3d6534f031139665ac0a1484b9204188ae369be4
MD5 8fafe48d7b916b30f4821a02525dc83d
BLAKE2b-256 6988b5355677de48be9da5fe15d2d36971f9d3b60cda756cbe6b59762496f4c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_argparse-0.0.1a9-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