← Back to issue list

docs: update sphinx-autodoc-typehints

View original Github issue

Metadata

Project
craft-parts
Number
#346
Type
pull request
State
merged
Author
tigarmo
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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

Issue Project State Summary Similarity
#55 docs: fix document generation craft-parts merged Merged following approval by two reviewers and successful CI checks. Added a documentation-specific requirements list to resolve Sphinx generation failures for Pydantic classes, modifying five files.
78%
#538 chore(deps): update documentation dependencies (major) rockcraft merged Merged automated dependency update upgrading Sphinx to 7.3.7 and sphinx-autodoc-typehints to 2.1.0. Approved by reviewers, passed CI, and merged with a minimal two-line change.
76%
#65 docs: fix sphinx doc generation and update docstrings craft-parts merged Merged after two approvals and passing CI. Fixed Sphinx doc generation by importing modules to resolve import cycles, and added missing parameter descriptions to docstrings across five files.
75%
#704 chore(deps): update dependency sphinx-autodoc-typehints to v2.0.1 craft-parts merged Automated dependency update for sphinx-autodoc-typehints merged from v2.0.0 to v2.0.1. The change passed CI, received two approvals, and was auto-merged per Renovate configuration.
75%
#643 chore(deps): update documentation dependencies craft-parts merged Merged automated documentation dependency updates. Renovate upgraded sphinx-autodoc-typehints and four sphinxcontrib packages to latest patch versions. Approved by two reviewers and passed CI before merge.
75%
#4128 docs: set sphinx autobuild-docs to watch the correct directories snapcraft merged Merged into main after two approvals and passing CI. Updates Sphinx autodoc configuration to monitor the correct directories, resolving issue #4123. Code coverage remained unchanged.
75%
#591 chore(deps): update documentation dependencies craft-parts merged Merged automated updates for sphinx-autodoc-typehints to 1.25.2, sphinxcontrib-applehelp to 1.0.7, and sphinxcontrib-devhelp to 1.0.5. Approved by reviewers, passed CI, and merged with minimal changes.
74%
#4367 docs: update sphinx theme snapcraft merged Merged documentation update for the Sphinx theme. Initial build failures were resolved by incorporating fixes from PR #4375 and minor adjustments. Approved by three reviewers, passed CI, and merged into main.
74%
#879 build(deps): update dependency sphinx-autodoc-typehints to v2.5.0 (main) - autoclosed craft-parts closed Renovate bot PR updating sphinx-autodoc-typehints from v2.2.2 to v2.5.0 was autoclosed due to inactivity. No reviews or CI checks were performed.
73%
#325 docs: use canonical-sphinx craft-application merged Merged documentation update to adopt canonical-sphinx and remove unused extensions. Approved by two reviewers, passed CI, and modified four files (+30/-83 lines).
72%