← Back to issue list

fix(docs): include poetry links as a target

View original Github issue

Metadata

Project
craft-parts
Number
#960
Type
pull request
State
merged
Author
lengau
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: The PR itself was merged into main as commit af641b90, appending the `craft_parts_poetry_links` label to the common Poetry plugin reference (line 114). This follows the earlier anchor work in #872 and #830 which added the same kind of include targets for downstream docs.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This allows applications that have their own custom poetry reference to include all the default links by adding the following to the bottom of their poetry plugin reference: ``` .. include:: /common/craft-parts/reference/plugins/poetry_plugin.rst :start-after: .. _craft_parts_poetry_links: ``` - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you added an entry to the changelog (`docs/reference/changelog.rst`)? -----

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged canonical/craft-parts#960, adding an RST include target so custom Poetry plugin references can include the default links.
qwen/qwen3.6-35b-a3b — — Merged a documentation fix adding an RST include directive that enables custom poetry plugins to reference default craft-parts links. Approved by two reviewers, passed CI, and applied with a two-line change.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update enabling custom poetry plugins to include default reference links via an RST include directive. Applications can now add a specific include statement to integrate standard poetry references.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/craft-parts#872 (confidence 80%)

    Earlier PR 'docs: add anchors to support charmcraft documentation' (commit 0436a75d) added the same style of RST anchors for downstream includes.

  • Related To: canonical/craft-parts#830 (confidence 70%)

    Commit aec88860 introduced the Poetry plugin reference file that this PR appends the links target to.

  • Superseded By: canonical/craft-parts#1349 (confidence 45%)

    Later commit 022d23cb 'docs: normalise plugin references' reworked the reference files; a4068934 later made the Poetry links inline, so the label may have been changed or dropped.

Related issues

Issue Project State Summary Similarity
#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.
76%
#1940 feat(docs): add python and poetry plugin docs charmcraft merged 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.
74%
#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.
74%
#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.
73%