Sphinx extension that automatically documents click applications

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for stephenfin from gravatar.com stephenfin

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT License)
  • Author: Stephen Finucane
  • Tags sphinx
  • Requires: Python >=3.6
Classifiers

Project description

Build Status Documentation Status

sphinx-click is a Sphinx plugin that allows you to automatically extract documentation from a click-based application and include it in your docs.

Installation

Install the plugin using pip:

$ pip install sphinx-click

Alternatively, install from source by cloning this repo then running setup.py:

$ python setup.py install

Usage

Enable the plugin in your Sphinx conf.py file:

extensions = ['sphinx_click']

Once enabled, you can now use the plugin wherever necessary in the documentation.

.. click:: module:parser
   :prog: hello-world
   :nested: full

Detailed information on the various options available is provided in the documentation.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for stephenfin from gravatar.com stephenfin

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT License)
  • Author: Stephen Finucane
  • Tags sphinx
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

6.0.0

5.2.2 yanked

5.2.1

5.2.0

5.1.0

5.0.1

5.0.0

4.4.0

4.3.0

4.2.0

4.1.0

4.0.3

4.0.2

4.0.1 yanked

Reason this release was yanked:

https://github.com/click-contrib/sphinx-click/issues/99

4.0.0

3.1.0

This version

3.0.3

3.0.2

3.0.1

3.0.0

2.7.1

2.7.0

2.6.0

2.5.0

2.4.0

2.3.2

2.3.1

2.3.0

2.2.0

2.1.0

2.0.1

2.0.0

1.4.1

1.4.0

1.3.0

1.2.0

1.1.0

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.0.1.dev2 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-click-3.0.3.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

sphinx_click-3.0.3-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-click-3.0.3.tar.gz.

File metadata

  • Download URL: sphinx-click-3.0.3.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.27.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.10.2

File hashes

Hashes for sphinx-click-3.0.3.tar.gz
Algorithm Hash digest
SHA256 1ea30b53e06b14088e6343d200cdabe5e50304311eb281234768073b49135d8e
MD5 f9e30bb2d7d8cb2de29400e59b396478
BLAKE2b-256 dcfbdf40d7fbf510ccd52a8f94dbede192730973049c304ffc22a3a9274591b6

See more details on using hashes here.

File details

Details for the file sphinx_click-3.0.3-py3-none-any.whl.

File metadata

  • Download URL: sphinx_click-3.0.3-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.27.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.10.2

File hashes

Hashes for sphinx_click-3.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6003bb8ce697e3512ce45f02c91b3ef8e6a1df50b6abfc0e95add9026f47dfde
MD5 a65ef2906d0051d7ab952f43f22d5a82
BLAKE2b-256 5c1846c7d034427dc357729340d238562870a1f43f4d9f3a2e0bcf3fed8fd744

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page