← Back to issue list

docs: add additional anchors on the "manage charms" page for linking to

View original Github issue

Metadata

Project
charmcraft
Number
#2129
Type
pull request
State
closed
Author
tonyandrewmeyer
Labels
—
Created
Updated
Closed

Current evaluation

Closed as a duplicate of #2128, which was merged as commit e880b4bd and added the requested intersphinx anchors to the Manage charms documentation.

Resolution: closed superseded

Reason: The author identified #2129 as a duplicate of canonical/charmcraft#2128. That superseding PR was merged with commit e880b4bd, adding the requested documentation anchors.

Evaluated by: mr-cal-bot

No scores available.

Issue body

From what I can tell, by default most of the headings in the "manage charms" page don't produce anchors that can be linked to with intersphinx: ``` $ intersphinx list https://canonical-charmcraft.readthedocs-hosted.com/en/stable --includes manage-charm std:label Manage charm bundles (manage-charm-bundles) https://canonical-charmcraft.readthedocs-hosted.com/en/stable/howto/manage-bundles/#manage-charm-bundles std:label Manage charm revisions (manage-charm-revisions) https://canonical-charmcraft.readthedocs-hosted.com/en/stable/howto/manage-revisions/#manage-charm-revisions std:label Manage charms (manage-charms) https://canonical-charmcraft.readthedocs-hosted.com/en/stable/howto/manage-charms/#manage-charms std:label Publish a charm on Charmhub (publish-a-charm) https://canonical-charmcraft.readthedocs-hosted.com/en/stable/howto/manage-charms/#publish-a-charm std:doc Manage charms (howto/manage-charms) https://canonical-charmcraft.readthedocs-hosted.com/en/stable/howto/manage-charms/ ``` We'd like to link to these individual sections from the ops docs, so the PR adds explicit anchors to link to. Refs: https://github.com/canonical/operator/pull/1546

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed superseded Closed as a duplicate of #2128, which was merged as commit e880b4bd and added the requested intersphinx anchors to the Manage charms documentation.
stealth/space-bunny-alpha — closed superseded Closed as a duplicate of #2128, which was merged in commit e880b4bd and added the requested intersphinx anchors to the Manage charms documentation.
stealth/space-bunny-alpha — closed superseded Closed as a duplicate of #2128, which merged the intersphinx anchor additions and related documentation fixes. This PR’s five-line change was not merged.
qwen/qwen3.6-35b-a3b — — Closed as a duplicate of PR #2128. The proposed documentation anchor additions were superseded by the referenced PR and not merged.
qwen3.6-35b-a3b-mtp-q6 — — Superseded by PR #2128. The pull request added explicit documentation anchors to the manage charms page to enable intersphinx linking from the ops docs.

Update history

No update history recorded yet.

Related work

  • Duplicate Of: canonical/charmcraft#2128 (confidence 100%)

    The author explicitly marked #2129 as a duplicate, and #2128 was merged as commit e880b4bd with the requested anchors.

  • Related To: operator#1546 (confidence 95%)

    The operator documentation PR motivated adding stable intersphinx anchors to Charmcraft's Manage charms page.

Related issues

Issue Project State Summary Similarity
#2128 docs: add anchors and fix a few small things charmcraft merged Docs PR merged as commit e880b4bd: added intersphinx anchors (e.g. _manage-charms, _initialise-a-charm) for Ops/Juju linking, retitled 'Set up Charmcraft' to 'Manage Charmcraft', expanded content, and fixed a rendering error.
81%
#872 docs: add anchors to support charmcraft documentation craft-parts merged Merged anchors for the Python and Poetry documentation, enabling Charmcraft to link into the Craft Parts docs (commit 0436a75d).
76%
#945 docs: update docs with extra ref anchors craft-parts merged Merged PR #945 added documentation reference anchors and a changelog entry for canonical/charmcraft#2050 (commit 5a1727ee).
74%
#2253 docs: add charm docs exemplars links charmcraft merged Merged #2253 as commit 982a6c16, adding links to small and large charm documentation exemplars.
73%
#2262 docs: hotfix for links syntax for charm docs examples charmcraft merged Merged PR #2262 as commit 675e5e7e, fixing links in the Manage charms docs and adding a Charmhub Discourse link.
71%
#2744 docs: adding the icon part to a charm is too hidden away charmcraft closed Docs gap closed by merged PR #2711 (commit 037c5b41): the Manage icons how-to now documents packaging icon.svg via a dump part, and the icon.svg reference page links to it.
70%