← Back to issue list

feat(docs): add python and poetry plugin docs

View original Github issue

Metadata

Project
charmcraft
Number
#1940
Type
pull request
State
merged
Author
lengau
Labels
—
Created
Updated
Closed

Current evaluation

PR #1940 merged as commit 408650c8, adding Python and Poetry plugin documentation (+144 lines, 6 files). Builds on #1939 (craft-parts common docs) and required craft-parts#872 anchors; merged despite12 unresolved review comments.

Resolution: closed resolved

Reason: Merged into main as commit 408650c8 ('feat(docs): add python and poetry plugin docs (#1940)') with 2 approvals. Its prerequisites also landed: charmcraft#1939 added craft-parts common docs and craft-parts#872 (commit 0436a75d) supplied the documentation anchors.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This adds documentation for the Python and Poetry plugins. It builds upon https://github.com/canonical/charmcraft/pull/1939 and requires https://github.com/canonical/craft-parts/pull/872 NOTE: This still needs a craft-parts update for all docs rendering to work properly, but please review what you can ITMT

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved PR #1940 merged as commit 408650c8, adding Python and Poetry plugin documentation (+144 lines, 6 files). Builds on #1939 (craft-parts common docs) and required craft-parts#872 anchors; merged despite12 unresolved review comments.
stealth/space-bunny-alpha — closed resolved Merged #1940 as 408650c8, adding Python and Poetry plugin documentation. It builds on #1939, with craft-parts#872 providing documentation anchors needed for full rendering.
stealth/space-bunny-alpha — closed resolved Merged charmcraft#1940 in commit 408650c8, adding Python and Poetry plugin documentation based on #1939. craft-parts#872 supplied the required rendering anchors.
stealth/space-bunny-alpha — closed resolved Merged #1940 as commit 408650c8, adding Python and Poetry plugin documentation. It builds on #1939 and required the documentation anchors added by craft-parts#872.
qwen/qwen3.6-35b-a3b — — Merged documentation for Python and Poetry plugins. Builds on charmcraft PR #1939 and requires craft-parts PR #872 for full rendering. Approved by two reviewers, adding 144 lines across six files.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update adding Python and Poetry plugin guides. Builds on PR #1939 and requires craft-parts PR #872 for full rendering. Integrated despite pending craft-parts updates.

Update history

No update history recorded yet.

Related work

  • Blocked By: canonical/craft-parts#872 (confidence 95%)

    Body states #1940 requires craft-parts#872 for doc anchors; merged as 0436a75d. PR note says a craft-parts version bump was still needed for full docs rendering.

  • Likely Fixed By: canonical/charmcraft#1939 (confidence 92%)

    Foundational PR adding shared craft-parts common documentation that #1940 explicitly builds upon.

Related issues

Issue Project State Summary Similarity
#1939 feat(docs): add craft-parts common documentation charmcraft merged Merged as 534c028f, adding shared craft-parts documentation across eight files and laying groundwork for Python and Poetry plugin guides in #1940.
87%
#830 feat(docs): add poetry plugin reference craft-parts merged Merged PR #830 as commit aec88860, adding Poetry plugin reference documentation across three files (+107/-1), following the plugin introduced in #820.
82%
#809 Reference documenation for the poetry plugin craft-parts closed Added Poetry plugin reference documentation in merged PR canonical/craft-parts#830 (commit aec88860), resolving the missing documentation request.
78%
#1913 Document the `python` and `poetry` plugins charmcraft closed Python and Poetry plugin docs were merged in #1940 (408650c8), with charm-to-Python/Poetry migration guides added in #1967 (ff00a899).
78%
#820 feat(plugin): add poetry plugin craft-parts merged Merged Poetry plugin support in commit 8b0d76c8, adding first-class build-system handling via poetry install and resolving #707.
75%
#960 fix(docs): include poetry links as a target craft-parts merged Merged as commit af641b90 (+2 lines): added an RST `.. _craft_parts_poetry_links:` include target at the end of docs/common/craft-parts/reference/plugins/poetry_plugin.rst, so apps with a custom Poetry reference can include the default links.
74%
#707 `poetry` Python plugin craft-parts closed Poetry plugin feature request implemented: PR #820 ("feat(plugin): add poetry plugin", commit 8b0d76c8) merged, later documented in #830 and fixed in #960. Issue closed by mr-cal on 2025-07-09 with "Completed via #820".
74%
#18 Poetry integration charmcraft closed Poetry support was ultimately delivered as Charmcraft-specific python/poetry craft-parts plugins, added in PR #1899 (commit 8b748f3e, 2023), superseding the older build.py requirements.txt idea; issue closed once shipped.
73%
#901 fix(poetry): don't install poetry with poetry-deps craft-parts merged PR #901 merged as commit 2eda2a5a: the Poetry plugin skips adding python3-poetry (and the export plugin) to build packages when a poetry-deps part supplies them. Fixes charmcraft#1996 (CRAFT-3687); noted in the 2.34.1 changelog.
73%
#1899 feat: add Python and Poetry plugins charmcraft merged Merged into main via commit 8b748f3e, adding Charmcraft-specific Python and Poetry plugins with charm-oriented venv, pip, source-copy, and binary defaults.
72%