Skip to content

fix(docs): bump mkdocstrings to 1.0.7 for pymdown-extensions 12.2 - #10629

Merged
isaacbmiller merged 1 commit into
mainfrom
fix/docs-mkdocstrings-pymdownx-12.2
Oct 12, 2026
Merged

isaacbmiller merged 1 commit into
mainfrom
fix/docs-mkdocstrings-pymdownx-12.2

Conversation

@isaacbmiller

Copy link
Copy Markdown
Collaborator

📝 Changes Description

Docs builds have been failing on every PR since Oct 10 with:

TypeError: Highlight.__init__() missing 1 required positional argument: 'md'

pymdown-extensions 12.2 (released 2026-10-10) made md a required argument of Highlight.__init__. docs/requirements.txt pins mkdocstrings==1.0.6, which doesn't pass it, but leaves pymdown-extensions unpinned, so fresh installs pick up 12.2. The last green docs run (Oct 9) differs from the failing runs only in pymdown-extensions 12.1 → 12.2.

mkdocstrings 1.0.7 includes the upstream fix (mkdocstrings/mkdocstrings@ff510f2, "fix: Support pymdownx 12.2"). This PR bumps the pin.

Verified locally with CI's command (python docs/scripts/build_docs.py current --config docs/mkdocs.yml) on Python 3.12 with pymdown-extensions 12.2:

  • mkdocstrings 1.0.7: build succeeds, API pages render with highlighted code.
  • mkdocstrings 1.0.6: reproduces the CI TypeError.

✅ Contributor Checklist

  • Pre-Commit checks are passing (locally and remotely)
  • Title of your PR / MR corresponds to the required format
  • Commit message follows required format {label}(dspy): {message}

⚠️ Warnings

mkdocstrings 1.0.7 drops Python 3.10 support. The docs workflows run on 3.12 (PR build) and 3.11 (publish), so CI is unaffected. The publish-current job on main hits the same failure until this merges.

pymdown-extensions 12.2 made Highlight.__init__ require an md argument,
which breaks mkdocstrings 1.0.6 and fails every docs build.

Amp-Thread-ID: https://ampcode.com/threads/T-01a13070-310d-739a-abc1-9b4c33bffaa6
Co-authored-by: Isaac Miller <isaac@cmpnd.ai>
@greptile-apps

greptile-apps Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

[Low impact] Safe to merge. The updated pin fixes the reproduced documentation build failure, and generated API highlighting remains functional.

T-Rex evidence

Evidence from the check

  • Executed the requested CI entry point in the preinstalled venv and captured its output; the command is reproducible.

Command output from the check

  • Captured the first requested documentation build with its command, working directory, and exit code; the build passed.

Evidence from the check

  • Installed only the previous mkdocstrings version into a separate overlay for comparison; the existing venv was preserved.

Command output from the check

  • Captured installation of mkdocstrings 1.0.6 without replacing shared dependencies; the comparison package was available.

Evidence from the check

  • Ran the same CI build with the previous package overlay and the current venv; only the mkdocstrings version changed.

Command output from the check

  • Captured the actual build using mkdocstrings 1.0.6 and pymdown-extensions 12.2; it failed because the required Markdown argument was missing.

Command output from the check

  • Captured the same build using mkdocstrings 1.0.7 and pymdown-extensions 12.2; it completed successfully.

Evidence from the check

  • Executed a checker that required keyword-like spans on every generated API page; that assertion was too narrow for an alias-only page.

Command output from the check

  • Captured the first inspection failure on BootstrapRS, which highlights names and operators rather than keywords; this was a checker limitation.

Evidence from the check

  • Executed the corrected checker against generated HTML and the installed highlighter; highlighted names, operators, keywords, and source were verified.

Evidence from the check

  • Ran HTML assertions, dependency compatibility validation, and tracked-file checks with captured output; all final checks passed.

Command output from the check

  • Captured generated source HTML, page-level token counts, installed requirements, and compatibility checks; all 72 generated API pages had highlighting and all 115 packages were compatible.

Evidence from the check

  • Printed numbered base and head constructor excerpts and checked the worktree; the fix and unchanged tracked files are traceable.

Command output from the check

  • Captured the missing base argument, conditional head argument forwarding, and pymdownx constructor requirement; the version bump addresses the reproduced failure.

View artifacts

Summary

Updates mkdocstrings from 1.0.6 to 1.0.7 to address the reported docs build failure with pymdown-extensions 12.2.

  • Documentation builds render API pages with pymdown-extensions 12.2.

Reviews (1) · Last reviewed commit: "fix(docs): bump mkdocstrings to 1.0.7 fo..." · Reviewed by Greptile

@isaacbmiller
isaacbmiller merged commit d41d142 into main Oct 12, 2026
38 of 42 checks passed
@isaacbmiller
isaacbmiller deleted the fix/docs-mkdocstrings-pymdownx-12.2 branch October 12, 2026 16:22
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