# mkdocs-click **Repository Path**: mirrors_DataDog/mkdocs-click ## Basic Information - **Project Name**: mkdocs-click - **Description**: An MkDocs extension to generate documentation for Click command line applications - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-08-08 - **Last Updated**: 2026-02-07 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # mkdocs-click ![Tests](https://github.com/mkdocs/mkdocs-click/workflows/CI/badge.svg?branch=master) ![Python versions](https://img.shields.io/pypi/pyversions/mkdocs-click.svg) [![PyPI](https://img.shields.io/pypi/v/mkdocs-click)](https://pypi.org/project/mkdocs-click/) An MkDocs extension to generate documentation for Click command line applications. Originally developed by [Datadog](https://www.datadoghq.com). ## Installation Install from PyPI: ```bash pip install mkdocs-click ``` ## Quickstart Add `mkdocs-click` to Markdown extensions in your `mkdocs.yml` configuration: ```yaml site_name: Example theme: readthedocs markdown_extensions: - mkdocs-click ``` Add a CLI application, e.g.: ```python # app/cli.py import click @click.group() def cli(): """Main entrypoint.""" @cli.command() @click.option("-d", "--debug", help="Include debug output.") def build(debug): """Build production assets.""" ``` Add a `mkdocs-click` block in your Markdown: ```markdown # CLI Reference This page provides documentation for our command line tools. ::: mkdocs-click :module: app.cli :command: cli ``` Start the docs server: ```bash mkdocs serve ``` Tada! 💫 ![](https://raw.githubusercontent.com/DataDog/mkdocs-click/master/docs/example.png) ## Usage ### Documenting commands To add documentation for a command, add a `mkdocs-click` block where the documentation should be inserted. Example: ```markdown ::: mkdocs-click :module: app.cli :command: main ``` For all available options, see the [Block syntax](#block-syntax). ### Multi-command support When pointed at a group (or any other multi-command), `mkdocs-click` will also generate documentation for sub-commands. This allows you to generate documentation for an entire CLI application by pointing `mkdocs-click` at the root command. ### Tweaking header levels By default, `mkdocs-click` generates Markdown headers starting at `

` for the root command section. This is generally what you want when the documentation should fill the entire page. If you are inserting documentation within other Markdown content, you can set the `:depth:` option to tweak the initial header level. Note that this applies even if you are just adding a heading. By default it is set to `0`, i.e. headers start at `

`. If set to `1`, headers will start at `

`, and so on. Note that if you insert your own first level heading and leave depth at its default value of 0, the page will have multiple `

` tags, which is not compatible with themes that generate page-internal menus such as the ReadTheDocs and mkdocs-material themes. ### Full command path headers By default, `mkdocs-click` outputs headers that contain the command name. For nested commands such as `$ cli build all`, this also means the heading would be `## all`. This might be surprising, and may be harder to navigate at a glance for highly nested CLI apps. If you'd like to show the full command path instead, turn on the [Attribute Lists extension](https://python-markdown.github.io/extensions/attr_list/): ```yaml # mkdocs.yaml markdown_extensions: - attr_list - mkdocs-click ``` IMPORTANT: `attr_list` must come before `mkdocs-click` for this to work. `mkdocs-click` will then output the full command path in headers (e.g. `## cli build all`) and permalinks (e.g. `#cli-build-all`). Note that the table of content (TOC) will still use the command name: the TOC is naturally hierarchal, so full command paths would be redundant. (This exception is why the `attr_list` extension is required.) ## Reference ### Block syntax The syntax for `mkdocs-click` blocks is the following: ```markdown ::: mkdocs-click :module: :command: :prog_name: :depth: :style: