From b170988a46651bbb277adcf8310cd5c7c981a207 Mon Sep 17 00:00:00 2001 From: Ilya Grigoriev Date: Wed, 7 Feb 2024 12:06:54 -0800 Subject: [PATCH] poetry: add the include-markdown MkDocs plugin --- mkdocs.yml | 1 + poetry.lock | 45 ++++++++++++++++++++++++++++++++++++++++++++- pyproject.toml | 1 + 3 files changed, 46 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index c801ef265..3e5ef6fd2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,6 +32,7 @@ extra: version: provider: mike plugins: + - include-markdown # For the CLI reference - search - redirects: redirect_maps: diff --git a/poetry.lock b/poetry.lock index 7c195e2a5..a22450b4c 100644 --- a/poetry.lock +++ b/poetry.lock @@ -17,6 +17,17 @@ pytz = {version = ">=2015.7", markers = "python_version < \"3.9\""} [package.extras] dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"] +[[package]] +name = "bracex" +version = "2.4" +description = "Bash style brace expander." +optional = false +python-versions = ">=3.8" +files = [ + {file = "bracex-2.4-py3-none-any.whl", hash = "sha256:efdc71eff95eaff5e0f8cfebe7d01adf2c8637c8c92edaf63ef348c241a82418"}, + {file = "bracex-2.4.tar.gz", hash = "sha256:a27eaf1df42cf561fed58b7a8f3fdf129d1ea16a81e1fadd1d17989bc6384beb"}, +] + [[package]] name = "certifi" version = "2023.11.17" @@ -415,6 +426,24 @@ watchdog = ">=2.0" i18n = ["babel (>=2.9.0)"] min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-import (==1.0)", "importlib-metadata (==4.3)", "jinja2 (==2.11.1)", "markdown (==3.2.1)", "markupsafe (==2.0.1)", "mergedeep (==1.3.4)", "packaging (==20.5)", "pathspec (==0.11.1)", "platformdirs (==2.2.0)", "pyyaml (==5.1)", "pyyaml-env-tag (==0.1)", "typing-extensions (==3.10)", "watchdog (==2.0)"] +[[package]] +name = "mkdocs-include-markdown-plugin" +version = "6.0.4" +description = "Mkdocs Markdown includer plugin." +optional = false +python-versions = ">=3.8" +files = [ + {file = "mkdocs_include_markdown_plugin-6.0.4-py3-none-any.whl", hash = "sha256:e7b8b5ecc41d6a3e16969cff3725ec3a391b68e9dfe1a4b4e36a8508becda835"}, + {file = "mkdocs_include_markdown_plugin-6.0.4.tar.gz", hash = "sha256:523c9c3a1d6a517386dc11bf60b0c0c564af1071bb6de8d213106d54f752dcc1"}, +] + +[package.dependencies] +mkdocs = ">=1.4" +wcmatch = ">=8,<9" + +[package.extras] +cache = ["platformdirs"] + [[package]] name = "mkdocs-material" version = "9.5.3" @@ -868,6 +897,20 @@ files = [ [package.extras] watchmedo = ["PyYAML (>=3.10)"] +[[package]] +name = "wcmatch" +version = "8.5" +description = "Wildcard/glob file name matcher." +optional = false +python-versions = ">=3.8" +files = [ + {file = "wcmatch-8.5-py3-none-any.whl", hash = "sha256:14554e409b142edeefab901dc68ad570b30a72a8ab9a79106c5d5e9a6d241bd5"}, + {file = "wcmatch-8.5.tar.gz", hash = "sha256:86c17572d0f75cbf3bcb1a18f3bf2f9e72b39a9c08c9b4a74e991e1882a8efb3"}, +] + +[package.dependencies] +bracex = ">=2.1.1" + [[package]] name = "zipp" version = "3.17.0" @@ -886,4 +929,4 @@ testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "p [metadata] lock-version = "2.0" python-versions = "^3.8" -content-hash = "658a54af430d9a471ab360b74069a27f2836843cc852134d9a73eb21080f9327" +content-hash = "9fd3db19cfcc4593d456d9d56e24678882e7c7abd11e4fd1bff7d07269d9b7af" diff --git a/pyproject.toml b/pyproject.toml index 69aa8c040..d9747794b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,6 +21,7 @@ mdx-breakless-lists = "^1.0.1" mkdocs-redirects = "^1.2.1" # Versioning of documentation mike = "^2.0.0" +mkdocs-include-markdown-plugin = "^6.0.4" [build-system] requires = ["poetry-core>=1.0.0"]