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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_argparse_neo-0.0.1a5.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.1a5.tar.gz
Algorithm Hash digest
SHA256 3d1539c548efd1deb8c1b9dfbf50d3edcf37148921363f6b81933e28e786b5f7
MD5 89baeea52de0f2eb7a4fcf0b7873f54c
BLAKE2b-256 72f59d236e2534e7d6c7e5b9cee3576884a9875b576c87626ad0b1d58ee70ab8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_argparse_neo-0.0.1a5-py3-none-any.whl
Algorithm Hash digest
SHA256 660d039c89c32dcafa1ae0170b999dd224b74d2a5c781af37a1a2ce1c0508b66
MD5 157b8e6bf7f5b1166eaff9c80a86e6d5
BLAKE2b-256 ad2de60dc03d1e770f9374a286808f4e699eaaed2e3cea5df9fe9bf915ea9703

See more details on using hashes here.

Provenance

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