Skip to main content

Sphinx extension that automatically documents click applications

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.


Install the plugin using pip:

$ pip install sphinx-click

Alternatively, install from source by cloning this repo then running pip locally:

$ pip install .


Enable the plugin in your Sphinx 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.


This plugin is perfect to document a Click-based CLI in Sphinx, as it properly renders the help screen and its options in nice HTML with deep links and styling.

However, if you are looking to document the source code of a Click-based CLI, and the result of its execution, you might want to check out click-extra. The latter provides the .. click:example:: and .. click:run:: Sphinx directives so you can capture and render, with full colors, the result of your CLI in your documentation.

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-click-5.1.0.tar.gz (27.5 kB view hashes)

Uploaded Source

Built Distribution

sphinx_click-5.1.0-py3-none-any.whl (9.7 kB view hashes)

Uploaded Python 3

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