Repository navigation
fix(docs): Bump mkdocstrings to 1.0.8 to fix docs build - #2306
Merged
Merged
Conversation
pymdown-extensions 12.2 made `md` a required argument of `Highlight.__init__`, which mkdocstrings 1.0.4 does not pass, so `mkdocs build` crashed rendering sdk-reference.md.
Contributor
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request. Check if the Files changed in this pull request are included in default exclusions.
Lockfile-only dependency bumps (e.g. #2291) could break the docs build without CI noticing.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The docs workflow has been failing since the pymdown-extensions 12.1 → 12.2 bump (#2291), on
main(v2.2.3 release run) and on open PRs like #2304:pymdown-extensions 12.2 made
mda required argument ofpymdownx.highlight.Highlight.__init__. mkdocstrings 1.0.4 subclasses it without passingmd.What
pyproject.tomlfloors are unchanged.uv.lockto the docs workflowpull_requestpaths, so lockfile-only bumps like build(deps): bump pymdown-extensions from 12.1 to 12.2 #2291 run the docs build (that is how this slipped through).Testing
uv run mkdocs buildsucceeds (failed with theTypeErrorbefore).prek run --all-filesandpytestpass.