docs: fix document generation
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
Add a docs-specific list of requirements and fix sphinx doc generation
for pydantic classes.
Signed-off-by: Claudio Matsuoka <claudio.matsuoka@canonical.com>
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
-----
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged a fix for Sphinx documentation generation targeting Pydantic classes by introducing a dedicated documentation requirements list. The change resolves build errors and ensures accurate API reference output. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #346 docs: update sphinx-autodoc-typehints | craft-parts | merged | 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. | |
| #1501 build(docs): update and clean docs dependencies | craft-parts | merged | Merged following approval by three reviewers. Updated and cleaned documentation dependencies, removing sphinx-pydantic in favor of pydantic-kitbash. All required CI checks passed. | |
| #4766 docs: use canonical-sphinx | snapcraft | merged | Merged documentation update switching to canonical-sphinx. Consolidated requirements files and added docs_requires to setup.py. Approved by two reviewers with passing CI checks. | |
| #559 docs: use canonical-sphinx | rockcraft | merged | Merged documentation update to adopt canonical-sphinx. Added the dependency to setup.cfg and regenerated requirements-doc.txt by freezing the doc environment. Approved by two reviewers with passing CI across seven files. | |
| #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). | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged documentation update to adopt canonical-sphinx. Approved by two reviewers, modifying two files with 45 additions and 36 deletions. | |
| #23 docs: use canonical-sphinx | craft-grammar | merged | Merged after two approvals and passing CI. Updates documentation to use canonical-sphinx, modifying 7 files with a net reduction of 72 lines. | |
| #486 docs: fixed broken references | craft-parts | merged | Merged after rebasing on main to resolve a mypy test failure caused by a pydantic 2.0 update. Approved by three reviewers, the change fixes broken documentation references across four files. | |
| #153 docs: add docstrings to Pydantic fields | imagecraft | merged | Merged after approval from two reviewers. Adds docstrings to Pydantic fields, includes Kitbash as a documentation dependency, and drafts a YAML reference. CI passed with minor spread test failures. Changes integrated into the main branch. |