Skip to content

fix(docs): cap typer <0.26.8 (0.26.8 broke the Documentation build)#84

Merged
ubmarco merged 1 commit into
mainfrom
fix/cap-typer-docs-ci
Jun 28, 2026
Merged

fix(docs): cap typer <0.26.8 (0.26.8 broke the Documentation build)#84
ubmarco merged 1 commit into
mainfrom
fix/cap-typer-docs-ci

Conversation

@ubmarco

@ubmarco ubmarco commented Jun 28, 2026

Copy link
Copy Markdown
Member

Problem

The Documentation build CI job is failing repo-wide — every open PR, and main too if re-run:

sphinx-build -nW --keep-going -b html -T -c docs docs/source docs/_build/html
AttributeError: module 'typer.rich_utils' has no attribute 'STYLE_METAVAR'

typer 0.26.8 removed rich_utils.STYLE_METAVAR and STYLE_METAVAR_SEPARATOR. The docs auto-document the Typer CLI via the .. typer:: sphinx_codelinks.cmd.app directive from sphinxcontrib-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.

typer STYLE_METAVAR / STYLE_METAVAR_SEPARATOR
0.16.0 – 0.26.7 ✅ present
0.26.8 (latest) ❌ removed

Fix

Cap typer<0.26.8 in pyproject.toml. 0.26.7 has both required symbols, and the runtime CLI only needs >=0.16.0, so it's unaffected. Bumping sphinxcontrib-typer is 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 exact tox -e docs-clean command) builds clean locally with the cap — typer resolves to 0.26.7, build succeeded. The committed lockfiles already pin typer==0.26.7, confirming that's the last-good version.

Merging this unblocks the Documentation build for main and all open PRs.

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-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.82%. Comparing base (00e1371) to head (056e14e).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ubmarco ubmarco requested a review from bburda June 28, 2026 17:44
@ubmarco ubmarco marked this pull request as ready for review June 28, 2026 17:46
@ubmarco ubmarco merged commit a441c17 into main Jun 28, 2026
13 checks passed
@ubmarco ubmarco deleted the fix/cap-typer-docs-ci branch June 28, 2026 17:53
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.

3 participants