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

Reason this release was yanked:

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

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

This version

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

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

Uploaded Source

Built Distribution

sphinx_click-4.0.1-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx-click-4.0.1.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for sphinx-click-4.0.1.tar.gz
Algorithm Hash digest
SHA256 6d0bc3de8b77a1e7623061d1f1b4fcb3ba4af0471a14c5f3f40d9852156163f9
MD5 78130712c5f73c50d79b883fdf572202
BLAKE2b-256 4a159b62609465d1109dc3004a6b8f469bd570fd5e37f42d2cc50ac477bfdf2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_click-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7569b9eec0102344a4f9fa18b1d916624ab71a47a95d2ef6113b5b7f9402bc2b
MD5 122000a28ccf4ceb1f7ce76426764806
BLAKE2b-256 dc2df993bfd724d2d524dbde11c64dbd28660472a7ec822ebd56853abe7a85ce

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