docs: update and fix doc generation
Metadata
Current evaluation
Merged docs-generation fixes in #40 via commit 6897a11 (merge c0b6bf2), adding sphinx-pydantic, executor/base reference sections, and refreshed requirements.
Resolution: closed resolved
Reason: PR #40 was merged into the mainline as c0b6bf2, with implementation commit 6897a11. It fixed generated documentation compatibility and expanded the documented API sections.
Evaluated by: mr-cal-bot
No scores available.
Issue body
sphinx-pydantic is required because pydantic will break when
importing with TYPE_CHECKING. The extension appears to work
around the issue, which would otherwise break most of the auto
generated documentation.
Add executors and bases documentation sections.
Re-freeze requirements.
Signed-off-by: Chris Patterson <chris.patterson@canonical.com>
- [ ] 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 docs-generation fixes in #40 via commit 6897a11 (merge c0b6bf2), adding sphinx-pydantic, executor/base reference sections, and refreshed requirements. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #40 fixed documentation generation with sphinx-pydantic, added executor and base API sections, and re-froze requirements in commit 6897a11. | |
| qwen/qwen3.6-35b-a3b | — | closed resolved | Merged PR updating documentation generation by adding sphinx-pydantic extension, adding executors and bases documentation sections, and re-freezing requirements. |
Update history
| Date | Change |
|---|---|
| created |
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #55 docs: fix document generation | craft-parts | merged | Merged PR #55 as cafc6d42, adding docs-specific requirements and fixing Sphinx document generation for Pydantic classes. | |
| #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. | |
| #1501 build(docs): update and clean docs dependencies | craft-parts | merged | Merged as 753f2044: updated and cleaned documentation dependencies, removing sphinx-pydantic after migration to pydantic-kitbash. | |
| #72 docs: update documentation dependencies | craft-archives | merged | Documentation dependencies were updated and merged via #72 (commit 83e16ec); the one-file, +3/-3 change was approved with no unresolved comments. |