Skip to main content

Modern Sphinx extension for documenting argparse-based CLI tools

Project description

sphinx-argparse-neo

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-argparse-neo

Usage

In your docs/conf.py:

extensions = ["sphinx_argparse_neo"]

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_argparse_neo-0.0.1a6.tar.gz (37.1 kB view details)

Uploaded Source

Built Distribution

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

sphinx_argparse_neo-0.0.1a6-py3-none-any.whl (41.4 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_argparse_neo-0.0.1a6.tar.gz.

File metadata

  • Download URL: sphinx_argparse_neo-0.0.1a6.tar.gz
  • Upload date:
  • Size: 37.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_argparse_neo-0.0.1a6.tar.gz
Algorithm Hash digest
SHA256 b9413e30557193a9f11cd70ae191becfb55a003116c94f483cd8cdcf44dfd60d
MD5 f62a2d893cd1f15141eb39e2338efbc0
BLAKE2b-256 200187e6afe4637fa17828205a8e9905ac60451bd278cf3a256ca15bccb02ae6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_argparse_neo-0.0.1a6.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_argparse_neo-0.0.1a6-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_argparse_neo-0.0.1a6-py3-none-any.whl
Algorithm Hash digest
SHA256 16c15c21dbba2b5fa533ee642f8902d3a7a05d104f15cd7514b08264de2813d3
MD5 d56e05addbec3322273f9066cbcfd555
BLAKE2b-256 6645b3c4f8215a3a8d7742e452dcc23c3c8feba2ce854127d1b0319a7ee9f355

See more details on using hashes here.

Provenance

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