fix: pin mkdocs<2.0 to restore Material theme on docs site#114
fix: pin mkdocs<2.0 to restore Material theme on docs site#114eurunuela merged 2 commits intoME-ICA:masterfrom
Conversation
mkdocs 2.0 is incompatible with mkdocs-material 9.x. When installed unpinned, pip now resolves to mkdocs 2.0 which causes the build to produce broken HTML with a Jekyll meta tag instead of the Material theme. Pinning mkdocs<2.0 ensures the docs site renders correctly with the Material theme. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Deploy Preview for rica-fmri ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Pins MkDocs in the documentation GitHub Actions workflow to keep the MkDocs Material theme working and restore correct rendering on the published docs site.
Changes:
- Update the docs workflow install step to add a
mkdocs<2.0constraint while installingmkdocs-material.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.github/workflows/docs.yml
Outdated
|
|
||
| - name: Install dependencies | ||
| run: pip install mkdocs-material | ||
| run: pip install mkdocs-material "mkdocs<2.0" |
There was a problem hiding this comment.
mkdocs-material is still unpinned here, so the workflow can break again when a new major/minor release of mkdocs-material changes its MkDocs compatibility. Consider pinning mkdocs-material to a known-compatible range (or using a checked-in requirements/constraints file) alongside mkdocs<2.0 to make the docs build reproducible.
| run: pip install mkdocs-material "mkdocs<2.0" | |
| run: pip install "mkdocs-material>=9,<10" "mkdocs<2.0" |
Per review feedback: mkdocs-material was still unpinned, meaning a future major release could break the build again. Pin to the 9.x series alongside mkdocs<2.0. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
eurunuela
left a comment
eurunuela
left a comment
There was a problem hiding this comment.
Addressed — is now also pinned to .
Summary
mkdocs<2.0in the docs workflow install step to fix the broken docs site at https://me-ica.github.io/rica/Problem
pip install mkdocs-material(unpinned) now resolves to mkdocs 2.0, which is incompatible with mkdocs-material 9.x. The build technically "succeeds" but produces broken HTML — the deployed site has a Jekyll meta tag and none of the Material CSS/JS, making it unusable.Fix
One-line change: add
"mkdocs<2.0"to the pip install command so mkdocs-material continues to work with a compatible mkdocs 1.x version.Test plan
workflow_dispatchon master🤖 Generated with Claude Code