Skip to content

Build AI methods with your coding agent, then run them anywhere: as an MCP for chatbots, as a webapp for people, or via API for your software.

chore/Cap-mkdocs-below-2 · L-261011-81e3f6 (#1416)

Louis Choquele01055220142
diff --git a/.github/workflows/doc-check.yml b/.github/workflows/doc-check.yml
index 93959944f..50b7dd47b 100644
--- a/.github/workflows/doc-check.yml
+++ b/.github/workflows/doc-check.yml
@@ -40,4 +40,7 @@ jobs:
run: uv sync --frozen --no-install-project --extra docs
- name: Check documentation build
+ # Silences Material for MkDocs' MkDocs 2.0 warning, as the Makefile's docs targets do.
+ env:
+ NO_MKDOCS_2_WARNING: "true"
run: uv run --no-sync mkdocs build --strict
diff --git a/Makefile b/Makefile
index b155f0a59..42a951ad7 100644
--- a/Makefile
+++ b/Makefile
@@ -18,7 +18,9 @@ VENV_RUFF := "$(VIRTUAL_ENV)/bin/ruff"
VENV_PYRIGHT := "$(VIRTUAL_ENV)/bin/pyright"
VENV_MYPY := "$(VIRTUAL_ENV)/bin/mypy"
VENV_PIPELEX := "$(VIRTUAL_ENV)/bin/pipelex"
-VENV_MKDOCS := "$(VIRTUAL_ENV)/bin/mkdocs"
+# Material for MkDocs prints a MkDocs 2.0 warning on every `mkdocs` run; we stay on MkDocs 1.x
+# (capped below 2 in pyproject.toml) until the docs move to Zensical.
+VENV_MKDOCS := NO_MKDOCS_2_WARNING=true "$(VIRTUAL_ENV)/bin/mkdocs"
VENV_MIKE := "$(VIRTUAL_ENV)/bin/mike"
VENV_PYLINT := "$(VIRTUAL_ENV)/bin/pylint"
VENV_PLXT := RUST_LOG=warn "$(VIRTUAL_ENV)/bin/plxt"
diff --git a/pyproject.toml b/pyproject.toml
index 0d19d4f5a..65550db0b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -110,7 +110,7 @@ dynamodb = ["boto3>=1.34.131"]
s3 = ["boto3>=1.42.42", "aiobotocore>=3.0.0"]
docs = [
"mike>=2.1.3",
- "mkdocs>=1.6.1",
+ "mkdocs>=1.6.1,<2",
"mkdocs-glightbox>=0.4.0",
"mkdocs-material>=9.7.7",
"mkdocs-meta-manager>=1.1.0",
diff --git a/uv.lock b/uv.lock
index d3aca5392..705ae7f26 100644
--- a/uv.lock
+++ b/uv.lock
@@ -3701,7 +3701,7 @@ requires-dist = [
{ name = "markdown-it-py", extras = ["linkify"], specifier = ">=3.0.0" },
{ name = "mike", marker = "extra == 'docs'", specifier = ">=2.1.3" },
{ name = "mistralai", marker = "extra == 'mistralai'", specifier = ">=2.10.0" },
- { name = "mkdocs", marker = "extra == 'docs'", specifier = ">=1.6.1" },
+ { name = "mkdocs", marker = "extra == 'docs'", specifier = ">=1.6.1,<2" },
{ name = "mkdocs-glightbox", marker = "extra == 'docs'", specifier = ">=0.4.0" },
{ name = "mkdocs-llmstxt-md", marker = "extra == 'docs'", specifier = ">=0.2.0" },
{ name = "mkdocs-material", marker = "extra == 'docs'", specifier = ">=9.7.7" },