From 951c31ed285f3a5933720477c31874659e4cb62d Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Tue, 20 Oct 2026 19:36:26 +0800 Subject: [PATCH 1/2] fix: pin Python API documentation build dependencies --- .github/workflows/build_static_website.yml | 2 +- .github/workflows/pr-preview-build.yml | 2 +- api-reference/python-api/README.md | 7 ++++--- api-reference/python-api/requirements.txt | 8 ++++++++ 4 files changed, 14 insertions(+), 5 deletions(-) create mode 100644 api-reference/python-api/requirements.txt diff --git a/.github/workflows/build_static_website.yml b/.github/workflows/build_static_website.yml index 632b91653..a94ad016d 100644 --- a/.github/workflows/build_static_website.yml +++ b/.github/workflows/build_static_website.yml @@ -40,7 +40,7 @@ jobs: - name: Install Dependencies run: | python -m pip install --upgrade pip - pip install mkdocs-material 'mkdocstrings[python]' black + pip install -r api-reference/python-api/requirements.txt pip install zvec npm ci diff --git a/.github/workflows/pr-preview-build.yml b/.github/workflows/pr-preview-build.yml index d8219dc8b..2c12abe1d 100644 --- a/.github/workflows/pr-preview-build.yml +++ b/.github/workflows/pr-preview-build.yml @@ -42,7 +42,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install mkdocs-material 'mkdocstrings[python]' black + pip install -r api-reference/python-api/requirements.txt pip install zvec npm ci diff --git a/api-reference/python-api/README.md b/api-reference/python-api/README.md index 9fe80f42e..b6d906d33 100644 --- a/api-reference/python-api/README.md +++ b/api-reference/python-api/README.md @@ -6,10 +6,11 @@ This is the official Python API reference documentation for the Zvec library, bu ### 1. Install Dependencies +Run these commands from `api-reference/python-api`. Both CI workflows use the same +pinned documentation tools in `requirements.txt`. + ```bash -pip install mkdocs-material -pip install 'mkdocstrings[python]' -pip install black +pip install -r requirements.txt pip install zvec ``` diff --git a/api-reference/python-api/requirements.txt b/api-reference/python-api/requirements.txt new file mode 100644 index 000000000..140ddab7c --- /dev/null +++ b/api-reference/python-api/requirements.txt @@ -0,0 +1,8 @@ +# Documentation tool versions from the successful PR build on 2026-09-23. +mkdocs==1.6.1 +mkdocs-material==9.7.7 +mkdocstrings[python]==1.0.6 +mkdocstrings-python==2.0.9 +# 12.2+ requires a Markdown argument that mkdocstrings 1.0.6 does not pass. +pymdown-extensions==12.1 +black==26.5.1 From 7f61cbf0912c100e8b7bcd259767b591562c2423 Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Tue, 20 Oct 2026 19:40:39 +0800 Subject: [PATCH 2/2] docs: simplify dependency installation instructions --- api-reference/python-api/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/api-reference/python-api/README.md b/api-reference/python-api/README.md index b6d906d33..4ceba2f53 100644 --- a/api-reference/python-api/README.md +++ b/api-reference/python-api/README.md @@ -6,8 +6,7 @@ This is the official Python API reference documentation for the Zvec library, bu ### 1. Install Dependencies -Run these commands from `api-reference/python-api`. Both CI workflows use the same -pinned documentation tools in `requirements.txt`. +Run these commands from `api-reference/python-api`. ```bash pip install -r requirements.txt