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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_argparse_neo-0.0.1a4.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.1a4.tar.gz
Algorithm Hash digest
SHA256 52ad8e2aa2a0f6a50973682ba4bfabe0ebafe7b29d7b9e411ed66d3f4868d52c
MD5 2dc713c0e947e4123a9b4b6bbce61962
BLAKE2b-256 3c46b185c9f00a9a66637717bbb8daed79d7aef45a183b8c93361a46f782a27a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_argparse_neo-0.0.1a4-py3-none-any.whl
Algorithm Hash digest
SHA256 e7e30c0d70cafed0e552aad530f6b161ed528bfc28c083968cccdc0d26cf0fcb
MD5 a8a115e38a862a772b76ceed38c7b7a0
BLAKE2b-256 c2ab2d5d4b66d9a3aec87c5fdb900b021ed974019ff4e8e0d39c88ce66747743

See more details on using hashes here.

Provenance

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