{"author":null,"author_email":"Ofek Lev ","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Environment :: Console","Environment :: Web Environment","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Topic :: Documentation","Topic :: Software Development :: Documentation","Topic :: Text Processing :: Markup :: Markdown","Typing :: Typed"],"description":"# mkdocs-click\n\n![Tests](https://github.com/mkdocs/mkdocs-click/workflows/CI/badge.svg?branch=master)\n![Python versions](https://img.shields.io/pypi/pyversions/mkdocs-click.svg)\n[![PyPI](https://img.shields.io/pypi/v/mkdocs-click)](https://pypi.org/project/mkdocs-click/)\n\nAn MkDocs extension to generate documentation for Click command line applications.\n\nOriginally developed by [Datadog](https://www.datadoghq.com).\n\n## Installation\n\nInstall from PyPI:\n\n```bash\npip install mkdocs-click\n```\n\n## Quickstart\n\nAdd `mkdocs-click` to Markdown extensions in your `mkdocs.yml` configuration:\n\n```yaml\nsite_name: Example\ntheme: readthedocs\n\nmarkdown_extensions:\n - mkdocs-click\n```\n\nAdd a CLI application, e.g.:\n\n```python\n# app/cli.py\nimport click\n\n@click.group()\ndef cli():\n \"\"\"Main entrypoint.\"\"\"\n\n@cli.command()\n@click.option(\"-d\", \"--debug\", help=\"Include debug output.\")\ndef build(debug):\n \"\"\"Build production assets.\"\"\"\n```\n\nAdd a `mkdocs-click` block in your Markdown:\n\n```markdown\n# CLI Reference\n\nThis page provides documentation for our command line tools.\n\n::: mkdocs-click\n :module: app.cli\n :command: cli\n```\n\nStart the docs server:\n\n```bash\nmkdocs serve\n```\n\nTada! 💫\n\n![](https://raw.githubusercontent.com/DataDog/mkdocs-click/master/docs/example.png)\n\n## Usage\n\n### Documenting commands\n\nTo add documentation for a command, add a `mkdocs-click` block where the documentation should be inserted.\n\nExample:\n\n```markdown\n::: mkdocs-click\n :module: app.cli\n :command: main\n```\n\nFor all available options, see the [Block syntax](#block-syntax).\n\n### Multi-command support\n\nWhen pointed at a group (or any other multi-command), `mkdocs-click` will also generate documentation for sub-commands.\n\nThis allows you to generate documentation for an entire CLI application by pointing `mkdocs-click` at the root command.\n\n### Tweaking header levels\n\nBy 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.\n\nIf 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.\n\nBy 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.\n\n### Full command path headers\n\nBy 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.\n\nIf you'd like to show the full command path instead, turn on the [Attribute Lists extension](https://python-markdown.github.io/extensions/attr_list/):\n\n```yaml\n# mkdocs.yaml\n\nmarkdown_extensions:\n - attr_list\n - mkdocs-click\n```\n\n`mkdocs-click` will then output the full command path in headers (e.g. `## cli build all`) and permalinks (e.g. `#cli-build-all`).\n\nNote 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.)\n\n## Reference\n\n### Block syntax\n\nThe syntax for `mkdocs-click` blocks is the following:\n\n```markdown\n::: mkdocs-click\n :module: \n :command: \n :prog_name: \n :depth: \n :style:

Dependencies of mkdocs-click (2).
Dependency	Optional
click	false
markdown	false

Package search

mkdocs-click

project_urls

Dependencies

All package metadata

Releases