Skip to content

fix: pin Python API documentation build dependencies - #71

Merged
zhourrr merged 2 commits into
mainfrom
codex/fix-python-docs-dependencies
Oct 20, 2026
Merged

zhourrr merged 2 commits into
mainfrom
codex/fix-python-docs-dependencies

Conversation

@zhourrr

@zhourrr zhourrr commented Oct 20, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

The production build after merging #67 failed while generating the Python API reference: mkdocstrings==1.0.6 called Highlight without the md argument required by pymdown-extensions 12.2 and later. The PR build had passed with 12.1, but both workflows installed unpinned documentation tools and production resolved 12.3.

Add a shared requirements file with the documentation tool versions from the successful September 23 PR build, including pymdown-extensions==12.1. Both production and PR preview builds now install from that file, and the local build instructions use it too.

Validation

  • Passed mkdocs build in a fresh Python 3.10 virtual environment using the shared requirements and zvec==0.7.0 (2.46 seconds).
  • Passed pip check and git diff --check.
  • PR Preview Build passed, including Python and Node.js API reference generation, the full website build, and artifact upload (1 minute 15 seconds).

Previous runs: passing PR build, failing production build.

@github-actions

github-actions Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

☁️ Cloudflare Pages preview: https://58729dfa.zvec-web.pages.dev

@zhourrr
zhourrr merged commit 42fecea into main Oct 20, 2026
1 check passed
@zhourrr
zhourrr deleted the codex/fix-python-docs-dependencies branch October 20, 2026 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant