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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_argparse_neo-0.0.1a3.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.1a3.tar.gz
Algorithm Hash digest
SHA256 1cc9fba001549b5aa3dee01fdf629fadd267a65721e86ae59c4c932990a8f6c0
MD5 705bcad0ae57202c3a059f21463e77da
BLAKE2b-256 974d14aa4d5bdcf5c2358acfd410b69afa2ee8a3935e52668c3090f7860554b6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_argparse_neo-0.0.1a3-py3-none-any.whl
Algorithm Hash digest
SHA256 49e2e4fd02b372ab07d41f86088a729f0c6b89700f825f0c99e4e4f4a9afae51
MD5 807263a6d073fd94f6718f0d74cfe268
BLAKE2b-256 331bf66f6a63e6fa77e8dba8f57577b35ed7d65847f2bf4851f1d490086c5e84

See more details on using hashes here.

Provenance

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