Add CLI reference page, auto-generated from Click (#2996)

mkdocs · Oct 8, 2022 · b2083d0 · b2083d0
1 parent aa10190
commit b2083d0
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md
@@ -15,6 +15,7 @@ bar at the top of the page to move through the documentation in order.
 - [Customizing Your Theme](customizing-your-theme.md)
 - [Localizing Your Theme](localizing-your-theme.md)
 - [Configuration](configuration.md)
+- [Command Line Interface](cli.md)
 - [Deploying Your Docs](deploying-your-docs.md)
 
 [Getting Started]: ../getting-started.md
diff --git a/docs/user-guide/cli.md b/docs/user-guide/cli.md
@@ -0,0 +1,8 @@
+# Command Line Interface
+
+::: mkdocs-click
+    :module: mkdocs.__main__
+    :command: cli
+    :prog_name: mkdocs
+    :style: table
+    :list_subcommands: true
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -42,6 +42,7 @@ markdown_extensions:
     - mdx_gh_links:
         user: mkdocs
         repo: mkdocs
+    - mkdocs-click
 
 copyright: Copyright &copy; 2014 <a href="https://twitter.com/_tomchristie">Tom Christie</a>, Maintained by the <a href="/about/release-notes/#maintenance-team">MkDocs Team</a>.
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -191,6 +191,7 @@ dependencies = [
     "mkdocs-redirects >=1.0.1",
     "pymdown-extensions >=8.0.1",
     "mkdocstrings-python >=0.7.1",
+    "mkdocs-click >=0.8.0",
 ]
 
 [tool.black]