docs: update sphinx-autodoc-typehints
Metadata
Current evaluation
Merged PR craft-parts#346 (commit 96d63c25) bumping sphinx-autodoc-typehints to fix broken Sphinx autodoc generation caused by the extension's poor interaction with Pydantic.
Resolution: closed resolved
Reason: The PR was approved and merged into main as commit 96d63c25, changing1 file (+3/-3) to upgrade the sphinx-autodoc-typehints documentation dependency so autodoc no longer breaks with Pydantic models. The dependency remains in the docs extra today.
Evaluated by: mr-cal-bot
No scores available.
Issue body
The doc generation from code (via autodoc) is currently broken because sphinx-autodoc-typehints was interacting badly with Pydantic; update sphinx-autodoc-typehints to a newer version to fix this.
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR craft-parts#346 (commit 96d63c25) bumping sphinx-autodoc-typehints to fix broken Sphinx autodoc generation caused by the extension's poor interaction with Pydantic. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged canonical/craft-parts#346 (commit 96d63c25), upgrading sphinx-autodoc-typehints to fix autodoc documentation generation broken by its interaction with Pydantic. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged an update to sphinx-autodoc-typehints that resolved documentation generation failures caused by Pydantic incompatibility. Approved by reviewer, passed CI, and applied to a single file. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged an update to sphinx-autodoc-typehints that fixes broken documentation generation caused by Pydantic compatibility issues. The maintainer tigarmo applied the version bump to restore autodoc functionality. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/craft-parts#704
(confidence 70%)
Later Renovate commit 7806906d updated the same dependency to v2.0.1, superseding the version pinned by #346.
-
Related To:
craft-parts#65
(confidence 45%)
Earlier docs-generation fixes (commits cc5b2a25, bb9d279d) touched the same Sphinx doc build area.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #65 docs: fix sphinx doc generation and update docstrings | craft-parts | merged | Merged in canonical/craft-parts#65 via a5373f23, fixing Sphinx type-hint import cycles and adding missing docstring parameter descriptions. | |
| #704 chore(deps): update dependency sphinx-autodoc-typehints to v2.0.1 | craft-parts | merged | Renovate PR #704 bumped the docs-only dependency sphinx-autodoc-typehints from 2.0.0 to 2.0.1 in craft-parts; it was approved (2 reviewers) and merged into main via commit 7806906d. | |
| #100 build(deps): update dependency sphinx-autodoc-typehints to v3 | craft-grammar | closed | Renovate PR #100 was closed unmerged: sphinx-autodoc-typehints 3.x could not update uv.lock because canonical-sphinx required Sphinx <8. |