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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_argparse_neo-0.0.1a2.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.1a2.tar.gz
Algorithm Hash digest
SHA256 02510d5dbedaf4a6b280b8ee0aa5ce5ee4c819fbe76c1cc91c6d310bc00cc39a
MD5 58f064832ce295b98b85c06daa921edf
BLAKE2b-256 81ba2c597467b1bf1c53ed42e2fca1e8cd57a9c7c403863d4aea2605b44c5d81

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_argparse_neo-0.0.1a2-py3-none-any.whl
Algorithm Hash digest
SHA256 08bd4bac581213042535f083d1681dc6725d483543c7e404812eed898d1b81c8
MD5 ce604887cb62fd70eac279ede23435ce
BLAKE2b-256 a6c787b7cf70ebe9c6c8401fedd4cfae5c0466ae5f13c76662b26ac1085e0498

See more details on using hashes here.

Provenance

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