docs: clean up 'snapcraft.yaml'
Metadata
Current evaluation
Merged docs cleanup in #5665 (30ab2b049): upgraded pydantic-kitbash to 0.0.7, removed library modules from sys.path, and declared currentmodule for Part Properties.
Resolution: closed resolved
Reason: PR #5665 was approved and merged as commit 30ab2b049, resolving the documentation warnings while preserving rendered content apart from a small formatting fix.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [X] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)?
- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [X] Have you successfully run `make lint`?
- [X] Have you successfully run `make test`?
---
* Update `pydantic-kitbash` to v0.0.7
* Remove library modules from `sys.path`
* Clean up 'Part Properties' by declaring ..py:currentmodule::
Once Snapcraft is updated to the next Craft Parts release, this will get rid of the Kitbash warnings in docs builds.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged docs cleanup in #5665 (30ab2b049): upgraded pydantic-kitbash to 0.0.7, removed library modules from sys.path, and declared currentmodule for Part Properties. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged #5665 (30ab2b049), updating pydantic-kitbash to v0.0.7, removing library modules from sys.path and adding currentmodule directives to clean up snapcraft.yaml docs. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged documentation cleanup for snapcraft.yaml. Updated pydantic-kitbash to v0.0.7, removed library modules from sys.path, and added currentmodule directives to resolve Kitbash warnings. Approved by two reviewers, passed CI, and modified four files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation cleanup for snapcraft.yaml. Updated pydantic-kitbash to v0.0.7, removed library modules from sys.path, and added a py:currentmodule directive. Eliminates Kitbash warnings in docs builds without altering rendered content. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5924 docs: clean up 'snapcraft.yaml' | snapcraft | merged | Merged snapcraft.yaml documentation cleanup in #5924 via commit 83f961ebc, upgrading pydantic-kitbash, correcting docstrings and links, and regenerating the JSON schema. | |
| #189 docs: clean up 'imagecraft.yaml' | imagecraft | merged | Merged in bfe4f70: updated pydantic-kitbash to v0.0.7, removed library modules from sys.path, and added currentmodule directives to clean up the imagecraft.yaml docs. | |
| #1196 docs: clean up 'Part Properties' | craft-parts | merged | Merged #1196 as c130c022: upgraded Kitbash to v0.0.7, fixed multiline field examples, removed craft_parts from sys.path, and eliminated Part Properties warnings. | |
| #5421 docs: add snapcraft.yaml reference | snapcraft | merged | Merged PR #5421 as commit 8a046bb00, adding generated snapcraft.yaml reference docs, project field docstrings, and pydantic-kitbash integration; the dependency was restored to PyPI before merge. | |
| #245 docs: clean up 'imagecraft.yaml' | imagecraft | merged | Merged as 3f819e5: upgraded pydantic-kitbash to v0.1.1, removed legacy workarounds, and cleaned up typos and language in the imagecraft.yaml documentation. | |
| #1149 docs: update 'Part properties' | craft-parts | merged | Merged in commit b5e87c2e, updating Part properties with #1129 model docs, adding pydantic-kitbash as a docs dependency, and revising documentation targets. | |
| #1056 docs: clean up 'rockcraft.yaml' | rockcraft | merged | Merged PR #1056 as commit 32d800b9, upgrading pydantic-kitbash to v0.1.1 and cleaning rockcraft.yaml docs by removing redundant modules and normalizing field order. | |
| #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. | |
| #5972 docs: incorporate pydantic-kitbash 1.0.0 | snapcraft | merged | Merged PR #5972 in commit f441d1d64, updating pydantic-kitbash docs to 1.0.0, removing redundant label overrides, and revising YAML-key references. | |
| #259 docs: incorporate Kitbash 1.0 | imagecraft | merged | Merged as canonical/imagecraft#259 (commit b1d6658): bumped pydantic-kitbash to v1.0 (new kitbash-field directives) and renamed imagecraft-yaml-file.rst to imagecraft-yaml.rst. Snap build failure was noted as unrelated. |