├── .github └── workflows │ ├── autofix.yml │ ├── ci.yml │ └── deploy-release.yml ├── .gitignore ├── .tools ├── copier-answers.yml └── test.sh ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── docs └── example.png ├── example ├── docs │ └── index.md └── mkdocs.yml ├── mkdocs_click ├── __init__.py ├── __version__.py ├── _docs.py ├── _exceptions.py ├── _extension.py ├── _loader.py ├── _processing.py └── py.typed ├── pyproject.toml ├── requirements └── requirements-style.txt └── tests ├── __init__.py ├── app ├── __init__.py ├── cli.py ├── expected-enhanced.md ├── expected-sub-enhanced.md ├── expected-sub.md └── expected.md ├── test_docs.py ├── test_extension.py ├── test_loader.py └── test_processing.py /.github/workflows/autofix.yml: -------------------------------------------------------------------------------- 1 | name: Auto-fix 2 | on: 3 | push: 4 | pull_request: 5 | jobs: 6 | style: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - name: Download source 10 | uses: actions/checkout@v4 11 | - name: Install Python 12 | uses: actions/setup-python@v5 13 | with: 14 | python-version: '3.12' 15 | - name: Install Hatch 16 | run: | 17 | pip install hatch 18 | - name: Install dependencies 19 | run: | 20 | hatch run style:pip freeze 21 | - name: Fix code style 22 | run: | 23 | hatch run style:fix --fix-only 24 | - name: Check if any edits are necessary 25 | run: | 26 | git diff --color --exit-code 27 | - name: Apply automatic fixes using pre-commit-ci-lite 28 | if: failure() && github.event_name == 'pull_request' 29 | uses: pre-commit-ci/lite-action@v1.1.0 30 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | pull_request: 5 | schedule: 6 | - cron: '0 6 * * 6' 7 | defaults: 8 | run: 9 | shell: bash 10 | jobs: 11 | test: 12 | strategy: 13 | fail-fast: false 14 | matrix: 15 | os: [ubuntu-latest, windows-latest, macos-latest] 16 | python: ["3.9", "3.10", "3.11", "3.12", "3.13"] 17 | 18 | runs-on: ${{matrix.os}} 19 | steps: 20 | - name: Download source 21 | uses: actions/checkout@v4 22 | - name: Install Python 23 | uses: actions/setup-python@v5 24 | with: 25 | python-version: ${{matrix.python}} 26 | - name: Install Hatch 27 | run: | 28 | pip install hatch 29 | - name: Install dependencies 30 | run: | 31 | hatch run test:pip freeze 32 | - name: Run tests 33 | run: | 34 | hatch run test:test 35 | style: 36 | runs-on: ubuntu-latest 37 | steps: 38 | - name: Download source 39 | uses: actions/checkout@v4 40 | - name: Install Python 41 | uses: actions/setup-python@v5 42 | with: 43 | python-version: '3.12' 44 | - name: Install Hatch 45 | run: | 46 | pip install hatch 47 | - name: Install dependencies 48 | run: | 49 | hatch run style:pip freeze 50 | hatch run types:pip freeze 51 | - name: Check style 52 | if: always() 53 | run: | 54 | hatch run style:check 55 | - name: Check types 56 | if: always() 57 | run: | 58 | hatch run types:check 59 | -------------------------------------------------------------------------------- /.github/workflows/deploy-release.yml: -------------------------------------------------------------------------------- 1 | name: Deploy release 2 | on: 3 | push: 4 | tags: 5 | - '*' 6 | jobs: 7 | pypi: 8 | permissions: 9 | id-token: write 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v4 13 | - name: Setup Python 14 | uses: actions/setup-python@v5 15 | with: 16 | python-version: '3.12' 17 | - name: Install dependencies 18 | run: pip install -U build 19 | - name: Build package 20 | run: python -m build 21 | - name: Publish to PyPI 22 | uses: pypa/gh-action-pypi-publish@release/v1 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .apyre/ 130 | 131 | # PyCharm 132 | .idea/ 133 | -------------------------------------------------------------------------------- /.tools/copier-answers.yml: -------------------------------------------------------------------------------- 1 | _commit: ed37f1413 2 | _src_path: gh:oprypin/py-project-template 3 | copyright_date: '2020' 4 | mkdocs: false 5 | mkdocs_install_self: false 6 | project_description: An MkDocs extension to generate documentation for Click command line applications 7 | project_name: mkdocs-click 8 | pytest: true 9 | python_distribution_name: mkdocs-click 10 | python_source_path: mkdocs_click 11 | repository_name: mkdocs/mkdocs-redirects 12 | script_test: true 13 | 14 | -------------------------------------------------------------------------------- /.tools/test.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -e 3 | 4 | cd "$(dirname "$0")/.." 5 | 6 | mkdocs build -q --strict -f example/mkdocs.yml 7 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). 6 | 7 | ## Unreleased 8 | 9 | ## 0.9.0 - 2025-04-07 10 | 11 | ### Changed 12 | 13 | - Drop support for Python 3.8. (Pull #85) 14 | 15 | ### Added 16 | 17 | - Add support for `click.Command`-like, `click.Group`-like and `click.Context`-like objects without requiring them to be actual subclasses. (Pull #82) 18 | 19 | ### Fixed 20 | 21 | - Remove explicit reference to `click.BaseCommand` and `click.MultiCommand` objects in anticipation of their deprecation. (Pull #82) 22 | - Properly ensure whitespace is trimmed from the usage string. (Pull #83) 23 | - Propagate `context_settings` to `click.Context`-like objects. (Pull #79) 24 | - Allow commands with no options. (Pull #84) 25 | 26 | ## 0.8.1 - 2023-09-18 27 | 28 | ### Fixed 29 | 30 | - `:prog_name:` and other options can now contain multiple words (it used to stop at whitespace). (Pull #60) 31 | - `::: mkdocs-click` directive is now recognized at the end of the file without needing an extra newline. (Pull #69) 32 | - Code blocks are marked as ```text so that HighlightJS doesn't try to highlight the "syntax" as some random language. (Pull #61) 33 | 34 | ## 0.8.0 - 2022-06-19 35 | 36 | ### Added 37 | 38 | - Add `list_subcommands` option. (Pull #55) 39 | 40 | ## 0.7.0 - 2022-04-28 41 | 42 | ### Added 43 | 44 | - Add `show_hidden` option. (Pull #52) 45 | - Update package metadata. (Pull #53) 46 | 47 | ## 0.6.0 - 2022-04-02 48 | 49 | ### Changed 50 | 51 | - Only support newer versions of `click` in response to a breaking change. (Pull #49) 52 | 53 | ## 0.5.0 - 2021-11-19 54 | 55 | ### Added 56 | 57 | - Add ability to ignore ASCII art. (Pull #45) 58 | 59 | ### Fixed 60 | 61 | - Correctly handle default values of `None`. (Pull #41) 62 | 63 | ## 0.4.0 - 2021-05-12 64 | 65 | ### Added 66 | 67 | - Relax `click` version constraint. (Pull #39) 68 | 69 | ## 0.3.0 - 2021-02-19 70 | 71 | ### Changed 72 | 73 | - `--help` is now kept in options (it used to be automatically dropped). (Pull #29) 74 | 75 | ### Added 76 | 77 | - Add table formatting. (Pulls #25, #30) 78 | - Use `:prog_name:` more consistently in usage. (Pull #24) 79 | - Allow using full command paths in headers. (Pull #36) 80 | 81 | ### Fixed 82 | 83 | - Make usage and options headings bold to improve legibility. (Pull #31) 84 | 85 | ## 0.2.0 - 2020-12-09 86 | 87 | ### Added 88 | 89 | - Add `:prog_name:` option to allow overriding the name of the CLI program. (Pull #8, contributed by @frankier.) 90 | - Add official support for Python 3.9. (Pull #20) 91 | 92 | ### Fixed 93 | 94 | - Properly pin `click==7.*` and `markdown==3.*`. (Pull #19) 95 | 96 | ## 0.1.1 - 2020-06-05 97 | 98 | ### Fixed 99 | 100 | - Raise proper error when processing unnamed commands. (Pull #4) 101 | 102 | ## 0.1.0 - 2020-06-04 103 | 104 | _Initial implementation._ 105 | 106 | ### Added 107 | 108 | - Add `::: mkdocs-click` block with `:module:`, `:command:` and `:depth:` options. 109 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing guidelines 2 | 3 | Thank you for being interested in contributing to this project! Here's how to get started. 4 | 5 | ## Setup 6 | 7 | To start developing on this project, create a fork of this repository on GitHub, then clone your fork on your machine: 8 | 9 | ```bash 10 | git clone https://github.com//mkdocs-click 11 | cd mkdocs-click 12 | ``` 13 | 14 | ## Example docs site 15 | 16 | You can run the example docs site that lives in `example/` locally using: 17 | 18 | ```bash 19 | hatch run test:mkdocs serve -f example/mkdocs.yml 20 | ``` 21 | 22 | ## Testing and linting 23 | 24 | You can run the test suite using: 25 | 26 | ```bash 27 | hatch run test:test 28 | ``` 29 | 30 | You can run code auto-formatting and style checks using: 31 | 32 | ```bash 33 | hatch run style:fix 34 | ``` 35 | 36 | ## Releasing 37 | 38 | _This section is for maintainers._ 39 | 40 | Before releasing a new version, create a pull request with: 41 | 42 | - An update to the changelog. 43 | - A version bump: see `__version__.py`. 44 | 45 | Merge the release PR, then create a release on GitHub. A tag will be created which will trigger a GitHub action to publish the new release to PyPI. 46 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mkdocs-click 2 | 3 | ![Tests](https://github.com/mkdocs/mkdocs-click/workflows/CI/badge.svg?branch=master) 4 | ![Python versions](https://img.shields.io/pypi/pyversions/mkdocs-click.svg) 5 | [![PyPI](https://img.shields.io/pypi/v/mkdocs-click)](https://pypi.org/project/mkdocs-click/) 6 | 7 | An MkDocs extension to generate documentation for Click command line applications. 8 | 9 | Originally developed by [Datadog](https://www.datadoghq.com). 10 | 11 | ## Installation 12 | 13 | Install from PyPI: 14 | 15 | ```bash 16 | pip install mkdocs-click 17 | ``` 18 | 19 | ## Quickstart 20 | 21 | Add `mkdocs-click` to Markdown extensions in your `mkdocs.yml` configuration: 22 | 23 | ```yaml 24 | site_name: Example 25 | theme: readthedocs 26 | 27 | markdown_extensions: 28 | - mkdocs-click 29 | ``` 30 | 31 | Add a CLI application, e.g.: 32 | 33 | ```python 34 | # app/cli.py 35 | import click 36 | 37 | @click.group() 38 | def cli(): 39 | """Main entrypoint.""" 40 | 41 | @cli.command() 42 | @click.option("-d", "--debug", help="Include debug output.") 43 | def build(debug): 44 | """Build production assets.""" 45 | ``` 46 | 47 | Add a `mkdocs-click` block in your Markdown: 48 | 49 | ```markdown 50 | # CLI Reference 51 | 52 | This page provides documentation for our command line tools. 53 | 54 | ::: mkdocs-click 55 | :module: app.cli 56 | :command: cli 57 | ``` 58 | 59 | Start the docs server: 60 | 61 | ```bash 62 | mkdocs serve 63 | ``` 64 | 65 | Tada! 💫 66 | 67 | ![](https://raw.githubusercontent.com/DataDog/mkdocs-click/master/docs/example.png) 68 | 69 | ## Usage 70 | 71 | ### Documenting commands 72 | 73 | To add documentation for a command, add a `mkdocs-click` block where the documentation should be inserted. 74 | 75 | Example: 76 | 77 | ```markdown 78 | ::: mkdocs-click 79 | :module: app.cli 80 | :command: main 81 | ``` 82 | 83 | For all available options, see the [Block syntax](#block-syntax). 84 | 85 | ### Multi-command support 86 | 87 | When pointed at a group (or any other multi-command), `mkdocs-click` will also generate documentation for sub-commands. 88 | 89 | This allows you to generate documentation for an entire CLI application by pointing `mkdocs-click` at the root command. 90 | 91 | ### Tweaking header levels 92 | 93 | 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. 94 | 95 | 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. 96 | 97 | 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. 98 | 99 | ### Full command path headers 100 | 101 | 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. 102 | 103 | 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/): 104 | 105 | ```yaml 106 | # mkdocs.yaml 107 | 108 | markdown_extensions: 109 | - attr_list 110 | - mkdocs-click 111 | ``` 112 | 113 | ***IMPORTANT:*** `attr_list` must come before `mkdocs-click` for this to work. 114 | 115 | `mkdocs-click` will then output the full command path in headers (e.g. `## cli build all`) and permalinks (e.g. `#cli-build-all`). 116 | 117 | 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.) 118 | 119 | ## Reference 120 | 121 | ### Block syntax 122 | 123 | The syntax for `mkdocs-click` blocks is the following: 124 | 125 | ```markdown 126 | ::: mkdocs-click 127 | :module: 128 | :command: 129 | :prog_name: 130 | :depth: 131 | :style: