From b2083d07f5d07ddfd82c1534bfef7203b77b4307 Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Sat, 8 Oct 2022 11:17:05 +0200 Subject: [PATCH] Add CLI reference page, auto-generated from Click (#2996) --- docs/user-guide/README.md | 1 + docs/user-guide/cli.md | 8 ++++++++ mkdocs.yml | 1 + pyproject.toml | 1 + 4 files changed, 11 insertions(+) create mode 100644 docs/user-guide/cli.md diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md index efa58d4c36..0b3cde3b7c 100644 --- 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 new file mode 100644 index 0000000000..987c13822c --- /dev/null +++ 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 index 47c90e73e6..844f236c0d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,6 +42,7 @@ markdown_extensions: - mdx_gh_links: user: mkdocs repo: mkdocs + - mkdocs-click copyright: Copyright © 2014 Tom Christie, Maintained by the MkDocs Team. diff --git a/pyproject.toml b/pyproject.toml index 233eb4aa9c..b3ee871861 100644 --- 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]