fix(docs): cap typer <0.26.8 (0.26.8 broke the Documentation build)#84
Merged
Conversation
typer 0.26.8 removed rich_utils.STYLE_METAVAR and STYLE_METAVAR_SEPARATOR, which sphinxcontrib-typer (the `.. typer::` CLI autodoc directive) still imports, so `sphinx-build -nW` crashes with AttributeError. typer is unpinned, so the Documentation build CI job broke repo-wide the moment 0.26.8 shipped. Cap typer below 0.26.8 (0.26.7 has both symbols; the runtime CLI is unaffected). Bumping sphinxcontrib-typer is not an option — even the latest 0.9.0 still references the removed symbols. Verified: `tox -e docs-clean` (sphinx-build -nW) builds clean with the cap.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #84 +/- ##
=======================================
Coverage 90.82% 90.82%
=======================================
Files 33 33
Lines 2942 2942
Branches 315 315
=======================================
Hits 2672 2672
Misses 168 168
Partials 102 102 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
bburda
approved these changes
Jun 28, 2026
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.
Problem
The Documentation build CI job is failing repo-wide — every open PR, and
maintoo if re-run:typer0.26.8 removedrich_utils.STYLE_METAVARandSTYLE_METAVAR_SEPARATOR. The docs auto-document the Typer CLI via the.. typer:: sphinx_codelinks.cmd.appdirective fromsphinxcontrib-typer, which still imports those symbols. Both deps are unpinned (typer>=0.16.0,sphinxcontrib-typer>=0.5.1), so the build broke the moment 0.26.8 shipped — independent of any PR's content.STYLE_METAVAR/STYLE_METAVAR_SEPARATORFix
Cap
typer<0.26.8inpyproject.toml. 0.26.7 has both required symbols, and the runtime CLI only needs>=0.16.0, so it's unaffected. Bumpingsphinxcontrib-typeris not an option — even the latest 0.9.0 still references the removed symbols (this likely warrants an upstream issue there as well).Verification
sphinx-build -nW --keep-going(the exacttox -e docs-cleancommand) builds clean locally with the cap — typer resolves to 0.26.7,build succeeded. The committed lockfiles already pintyper==0.26.7, confirming that's the last-good version.Merging this unblocks the Documentation build for
mainand all open PRs.