feat(mkdocs): use mkdocs-click to create the CLI reference

leodevian · leodevian · commit d03e0a51bf88 · 2025-12-07T15:31:05.000+01:00
diff --git a/changelog.d/+8ac4be7f.changed.md b/changelog.d/+8ac4be7f.changed.md
@@ -0,0 +1 @@
+Use mkdocs-click to create the CLI reference.
diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
@@ -100,6 +100,7 @@ type = [
 docs = [
   "black>=25.11",
   "mkdocs>=1.6.1",
+  "mkdocs-click>=0.9",
   "mkdocs-material>=9.7",
   "mkdocstrings-python>=2",
 ]
diff --git a/template/{% if docs %}docs{% endif %}/{% if docs == 'mkdocs' %}.{% endif %}/reference/{% if cli == 'click' %}cli.md{% endif %}.jinja b/template/{% if docs %}docs{% endif %}/{% if docs == 'mkdocs' %}.{% endif %}/reference/{% if cli == 'click' %}cli.md{% endif %}.jinja
@@ -0,0 +1,7 @@
+# Commands
+
+::: mkdocs-click
+    :module: {{ package_name }}.cli
+    :command: main
+    :prog_name: {{ distribution_name }}
+    :style: table
diff --git a/template/{% if docs %}docs{% endif %}/{% if docs == 'mkdocs' %}.{% endif %}/reference/{% if cli and cli != 'click' %}cli.md{% endif %}.jinja b/template/{% if docs %}docs{% endif %}/{% if docs == 'mkdocs' %}.{% endif %}/reference/{% if cli and cli != 'click' %}cli.md{% endif %}.jinja
diff --git a/template/{% if docs == 'mkdocs' %}mkdocs.yml{% endif %}.jinja b/template/{% if docs == 'mkdocs' %}mkdocs.yml{% endif %}.jinja
@@ -65,6 +65,10 @@ watch:
   - src/{{ package_name }}
 
 markdown_extensions:
+{%- if cli == 'click' %}
+  - attr_list
+  - mkdocs-click
+{%- endif %}
   - pymdownx.highlight:
       use_pygments: true
       pygments_lang_class: true

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Use mkdocs-click to create the CLI reference.`