Skip to content

Restrict mkdocs version to < 2#646

Merged
AdrianDAlessandro merged 1 commit intomainfrom
pin-mkdocs
Mar 24, 2026
Merged

Restrict mkdocs version to < 2#646
AdrianDAlessandro merged 1 commit intomainfrom
pin-mkdocs

Conversation

@AdrianDAlessandro
Copy link
Copy Markdown
Collaborator

Description

MkDocs 2.0 is coming and it will be incompatible with Mkdocs-material, which we use for the developer docs. For now, pin the version of mkdocs to prevent an automatic update

https://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/

Type of change

  • Documentation (non-breaking change that adds or improves the documentation)
  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Technical work (non-breaking, change which is work as part of a new feature)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass (eg. python -m pytest)
  • The documentation builds and looks OK (eg. mkdocs serve)
  • Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

MkDocs 2.0 is coming and it will be incompatible with Mkdocs-material, which we use for the developer docs. For now, pin the version of mkdocs to prevent an automatic update

https://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/
@AdrianDAlessandro AdrianDAlessandro merged commit 7c99be4 into main Mar 24, 2026
4 checks passed
@AdrianDAlessandro AdrianDAlessandro deleted the pin-mkdocs branch March 24, 2026 11:33
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.

2 participants