From 7ae92e23aa789235599199820e33228559f05563 Mon Sep 17 00:00:00 2001
From: Chris Sewell <chrisj_sewell@hotmail.com>
Date: Mon, 9 Nov 2026 18:50:02 +0100
Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=A7=AA=20TEST:=20count=20only=20the?=
 =?UTF-8?q?=20badge=20anchors=20in=20the=20bdg-ref=20tooltip=20test?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

`test_ref_badge_tooltip_survives_resolution` counted every
`href="#my-target"` in the page. With MyST-Parser master (heading-anchor
rework, executablebooks/MyST-Parser#1158) the explicit `(my-target)=` becomes
the section's primary id, so the theme's headerlink and sidebar TOC also link
to `#my-target` and the count is 4, not 2.

Count only the anchors carrying the `sd-badge` class, which is what the
assertion is about; it holds on MyST-Parser 5.1.0 and on master.
---
 tests/test_badge_tooltips.py | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/tests/test_badge_tooltips.py b/tests/test_badge_tooltips.py
index 57d505a7..7e2bb73d 100644
--- a/tests/test_badge_tooltips.py
+++ b/tests/test_badge_tooltips.py
@@ -22,6 +22,8 @@
 reStructuredText, and the MyST variants are guarded by ``MYST_PARAM``.
 """
 
+import re
+
 from docutils import nodes
 import pytest
 from sphinx import addnodes
@@ -349,8 +351,15 @@ def test_ref_badge_tooltip_survives_resolution(fmt, sphinx_builder):
     builder = _build(sphinx_builder, fmt, REF["rst"], REF["myst"])
     html = (builder.out_path / "index.html").read_text(encoding="utf8")
 
-    # both badges resolve to the target anchor
-    assert html.count('href="#my-target"') == 2
+    # both badges resolve to the target anchor; only the badge anchors are
+    # counted, since the theme's own links to the section (its headerlink,
+    # the sidebar TOC) depend on which id the parser makes the section's
+    # primary one, and MyST-Parser's heading-anchor rework
+    # (executablebooks/MyST-Parser#1158) makes it the explicit target
+    badge_anchors = re.findall(
+        r'<a class="[^"]*\bsd-badge\b[^"]*" href="#my-target"[ >]', html
+    )
+    assert len(badge_anchors) == 2
     # the tooltipped one carries the title; it survived resolution
     assert (
         '<a class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary'

From 49a1929f4d080b85dd18fbcc9ad4ca10d6d5eb3d Mon Sep 17 00:00:00 2001
From: Chris Sewell <chrisj_sewell@hotmail.com>
Date: Mon, 9 Nov 2026 18:52:22 +0100
Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A7=AA=20TEST:=20sort=20element=20ids?=
 =?UTF-8?q?=20in=20the=20snippet=20regression=20tests?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The RST and MyST snippet tests compare against one shared fixture. For a
section with an explicit target, docutils lists the title slug first
(`clickable-cards cards-clickable`), while MyST-Parser master (heading-anchor
rework, executablebooks/MyST-Parser#1158) lists the explicit target first, so
`test_snippets_myst[html-card-link]` and `test_snippets_myst_post[html-card-link]`
fail on master.

The order is a parser detail, not sphinx-design output: sort each element's
ids before serialising, in all four snippet tests, and regenerate the two
card-link fixtures (one line each). The full set of ids is still compared.
---
 tests/test_snippets.py                        | 24 +++++++++++++++----
 .../test_snippets/snippet_post_card-link.xml  |  2 +-
 tests/test_snippets/snippet_pre_card-link.xml |  2 +-
 3 files changed, 22 insertions(+), 6 deletions(-)

diff --git a/tests/test_snippets.py b/tests/test_snippets.py
index 884264c8..9752017e 100644
--- a/tests/test_snippets.py
+++ b/tests/test_snippets.py
@@ -3,6 +3,7 @@
 from collections.abc import Callable
 from pathlib import Path
 
+from docutils import nodes
 import pytest
 
 from .conftest import SphinxBuilder
@@ -25,6 +26,21 @@
 ]
 
 
+def sort_ids(doctree: nodes.document) -> nodes.document:
+    """Sort the ``ids`` of every element, in place.
+
+    The order of an element's ids is a parser detail, not sphinx-design output:
+    for a section with an explicit target, docutils lists the title slug first,
+    while MyST-Parser's heading-anchor rework (executablebooks/MyST-Parser#1158)
+    lists the explicit target first. Sorting keeps the RST and MyST snippets
+    comparing against the same fixture, and still checks the full set of ids.
+    """
+    for node in doctree.findall(nodes.Element):
+        if len(node["ids"]) > 1:
+            node["ids"] = sorted(node["ids"])
+    return doctree
+
+
 def write_assets(src_path: Path):
     """Write additional assets to the src directory."""
     src_path.joinpath("snippet.py").write_text("a = 1")
@@ -50,7 +66,7 @@ def test_snippets_rst(
     builder.src_path.joinpath("index.rst").write_text(content, encoding="utf8")
     write_assets(builder.src_path)
     builder.build()
-    doctree = builder.get_doctree("index", post_transforms=False)
+    doctree = sort_ids(builder.get_doctree("index", post_transforms=False))
     doctree.attributes.pop("translation_progress", None)  # added in sphinx 7.1
     file_regression.check(
         normalize_doctree_xml(doctree.pformat()),
@@ -78,7 +94,7 @@ def test_snippets_myst(
     builder.src_path.joinpath("index.md").write_text(content, encoding="utf8")
     write_assets(builder.src_path)
     builder.build()
-    doctree = builder.get_doctree("index", post_transforms=False)
+    doctree = sort_ids(builder.get_doctree("index", post_transforms=False))
     doctree.attributes.pop("translation_progress", None)  # added in sphinx 7.1
     file_regression.check(
         normalize_doctree_xml(doctree.pformat()),
@@ -105,7 +121,7 @@ def test_snippets_rst_post(
     builder.src_path.joinpath("index.rst").write_text(content, encoding="utf8")
     write_assets(builder.src_path)
     builder.build()
-    doctree = builder.get_doctree("index", post_transforms=True)
+    doctree = sort_ids(builder.get_doctree("index", post_transforms=True))
     doctree.attributes.pop("translation_progress", None)  # added in sphinx 7.1
     file_regression.check(
         normalize_doctree_xml(doctree.pformat()),
@@ -133,7 +149,7 @@ def test_snippets_myst_post(
     builder.src_path.joinpath("index.md").write_text(content, encoding="utf8")
     write_assets(builder.src_path)
     builder.build()
-    doctree = builder.get_doctree("index", post_transforms=True)
+    doctree = sort_ids(builder.get_doctree("index", post_transforms=True))
     doctree.attributes.pop("translation_progress", None)  # added in sphinx 7.1
     file_regression.check(
         normalize_doctree_xml(doctree.pformat()),
diff --git a/tests/test_snippets/snippet_post_card-link.xml b/tests/test_snippets/snippet_post_card-link.xml
index 3d74e127..59ec5e47 100644
--- a/tests/test_snippets/snippet_post_card-link.xml
+++ b/tests/test_snippets/snippet_post_card-link.xml
@@ -3,7 +3,7 @@
         <title>
             Heading
         <target refid="cards-clickable">
-        <section ids="clickable-cards cards-clickable" names="clickable\ cards cards-clickable">
+        <section ids="cards-clickable clickable-cards" names="clickable\ cards cards-clickable">
             <title>
                 Clickable cards
             <paragraph>
diff --git a/tests/test_snippets/snippet_pre_card-link.xml b/tests/test_snippets/snippet_pre_card-link.xml
index 86461813..2f7b35bf 100644
--- a/tests/test_snippets/snippet_pre_card-link.xml
+++ b/tests/test_snippets/snippet_pre_card-link.xml
@@ -3,7 +3,7 @@
         <title>
             Heading
         <target refid="cards-clickable">
-        <section ids="clickable-cards cards-clickable" names="clickable\ cards cards-clickable">
+        <section ids="cards-clickable clickable-cards" names="clickable\ cards cards-clickable">
             <title>
                 Clickable cards
             <paragraph>