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

CI 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

3.0.3

3.0.2

3.0.1

This version

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.0.tar.gz (19.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-click-3.0.0.tar.gz
  • Upload date:
  • Size: 19.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.4

File hashes

Hashes for sphinx-click-3.0.0.tar.gz
Algorithm Hash digest
SHA256 5f0d10a992eae1aa869b22720281eb3f2d0d8fa30364e75db31db52539c70f9e
MD5 2ffcb23826b7f58b808f2064f9f9523c
BLAKE2b-256 cc98ad03355eed8e5a1532fa0a2e6dff3013d657dd739afc2550a215baf504d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_click-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.9.4

File hashes

Hashes for sphinx_click-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ae8e558ffe3ee976410f2bbd9213d2c1127bd22df1a47099bf179e775f24591
MD5 ab45b844e304adde1da295602bc3803d
BLAKE2b-256 7f74f46515b66273b148d76fe493d439e110b9b9cf9599d0ddfce57126d8ced0

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