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
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.ext']

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

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

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
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

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

This version

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

Uploaded Source

Built Distribution

sphinx_click-2.0.1-py2.py3-none-any.whl (7.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: sphinx-click-2.0.1.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.3

File hashes

Hashes for sphinx-click-2.0.1.tar.gz
Algorithm Hash digest
SHA256 926da1a7c677ae1b35cf255269ff84fec65d0f92e4863acfa77b92cf8ae32275
MD5 1aec59ae38e34fb6e058fddda70da90b
BLAKE2b-256 e1e1f0f3aa6a8d83944b004c9f217e1f00b4f6bbc4fdc43d05d1539329af1d24

See more details on using hashes here.

File details

Details for the file sphinx_click-2.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: sphinx_click-2.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.3

File hashes

Hashes for sphinx_click-2.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f0c03d6ea0e4258c9c09646b6f745090ea8dd13e7e045903e4b789dfc02f7846
MD5 a8a33da8fdd93f7140b9e96709999cb0
BLAKE2b-256 6190a5a9180d39c515e845b1bfcd9285ce409070e6b39af73c8bbb1edc7f1304

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