{"library":"mkdocs-click","title":"MkDocs-Click","description":"MkDocs-Click is an MkDocs extension designed to automatically generate comprehensive documentation for Click command-line applications. It parses Click command structures and renders them directly into MkDocs pages, including options, arguments, and subcommands. The current version is 0.9.0, and it maintains an active release cadence, adapting to changes in both MkDocs and Click.","language":"python","status":"active","last_verified":"Fri May 15","install":{"commands":["pip install mkdocs-click"],"cli":{"name":"mkdocs","version":"sh: 1: mkdocs: not found"}},"imports":["from mkdocs_click.extension import ClickExtension"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"mkdocs new my-click-docs\ncd my-click-docs\npip install mkdocs mkdocs-click click\n\n# --- my_cli.py ---\nimport click\n\n@click.group()\ndef cli():\n    \"\"\"My super CLI tool.\"\"\"\n    pass\n\n@cli.command()\n@click.option('--count', default=1, help='Number of greetings.')\n@click.argument('name')\ndef hello(count, name):\n    \"\"\"Greets the NAME for a COUNT times.\"\"\"\n    for x in range(count):\n        click.echo(f\"Hello {name}!\")\n\n# --- mkdocs.yml ---\nsite_name: My Click Documentation\n\nextensions:\n  - mkdocs-click\n\n# --- docs/index.md ---\n# My Click Application Documentation\n\n```python\n# my_cli.py\nimport click\n\n@click.group()\ndef cli():\n    \"\"\"My super CLI tool.\"\"\"\n    pass\n\n@cli.command()\n@click.option('--count', default=1, help='Number of greetings.')\n@click.argument('name')\ndef hello(count, name):\n    \"\"\"Greets the NAME for a COUNT times.\"\"\"\n    for x in range(count):\n        click.echo(f\"Hello {name}!\")\n```\n\n:::{.mkdocs-click}\n#:\n  :module: my_cli\n  :command: cli\n:::\n\n# Building and serving\nmkdocs build\nmkdocs serve\n","lang":"bash","description":"To use mkdocs-click, first install it alongside MkDocs. Then, configure your `mkdocs.yml` to include the `mkdocs-click` extension. Create a Python file containing your Click application and reference it in your Markdown file using the `mkdocs-click` directive. The example shows a basic Click CLI and its integration into an MkDocs project.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-15","installed_version":"0.9.0","pypi_latest":"0.9.0","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":1.8,"avg_import_s":null,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"19.4M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":1.8,"import_time_s":null,"mem_mb":null,"disk_size":"20M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"21.5M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":1.8,"import_time_s":null,"mem_mb":null,"disk_size":"22M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"13.3M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":1.6,"import_time_s":null,"mem_mb":null,"disk_size":"14M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"13.1M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":1.6,"import_time_s":null,"mem_mb":null,"disk_size":"14M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"19.2M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"mkdocs-click","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":2.1,"import_time_s":null,"mem_mb":null,"disk_size":"20M"}]}}