Click Docs
Generate Markdown documentation for your Click application
Installation
$ pip install click-docs
Or with uv:
$ uv add click-docs
Requirements: Python 3.10+, Click 8.1+
Quick start
Given a file deployer.py containing a Click application:
$ click-docs deployer.py --program-name deployer --output docs/cli-reference.md
That's it. docs/cli-reference.md now contains the full Markdown reference for every command and option.
Common options
| Option | Description |
|---|---|
--program-name TEXT |
Display name in headings and usage lines |
--output FILE |
Write to file instead of stdout |
--style plain\|table |
Options rendering style |
--depth N |
Max subcommand depth (0 = root only) |
--exclude PATH |
Exclude a command by dotted path (repeatable) |
--list-subcommands |
Prepend a TOC of subcommands |
--remove-ascii-art |
Strip \b-prefixed ASCII art blocks |
Run click-docs --help for the full list.
What Next
Check out the Tutorials or Reference for more information. Developers should check out the Developer Guide for even more detailed information and advice on how to extend Click Docs.