From 6a39d4a528d71f48090470f1c0128a77770fca07 Mon Sep 17 00:00:00 2001 From: sogav21 <223452947+sogav21@users.noreply.github.com> Date: Thu, 19 Nov 2026 09:17:30 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=90=9B=20FIX:=20Render=20implicit=20gloss?= =?UTF-8?q?ary=20links=20as=20plain=20text?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 6 ++++++ myst_parser/sphinx_ext/myst_refs.py | 7 +++++- tests/test_renderers/test_myst_refs.py | 30 ++++++++++++++++++++++++++ 3 files changed, 42 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d79c7010..dec291c1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## Unreleased + +### 🐛 Bug Fixes + +- 🐛 Render implicit glossary link captions as plain text (). + ## 5.2.0 - 2026-11-10 Heading anchors are now stable and documented: diff --git a/myst_parser/sphinx_ext/myst_refs.py b/myst_parser/sphinx_ext/myst_refs.py index ae8980fe..98a094ad 100644 --- a/myst_parser/sphinx_ext/myst_refs.py +++ b/myst_parser/sphinx_ext/myst_refs.py @@ -306,8 +306,13 @@ def resolve_myst_ref_any( if key in stddomain.objects: docname, labelid = stddomain.objects[key] domain_role = "std:" + (stddomain.role_for_objtype(objtype) or "") + innernode = contnode + if objtype == "term" and not node["refexplicit"]: + innernode = nodes.inline( + target, target, classes=contnode["classes"] + ) ref_node = make_refnode( - self.app.builder, refdoc, docname, labelid, contnode + self.app.builder, refdoc, docname, labelid, innernode ) results.append((domain_role, ref_node)) diff --git a/tests/test_renderers/test_myst_refs.py b/tests/test_renderers/test_myst_refs.py index ced44061..2ab6daab 100644 --- a/tests/test_renderers/test_myst_refs.py +++ b/tests/test_renderers/test_myst_refs.py @@ -71,6 +71,36 @@ def test_parse( file_regression.check(outcome, basename=test_name, extension=".xml") +@pytest.mark.parametrize("term", ["example term", "café term"]) +def test_glossary_link_caption(term: str, sphinx_doctree: CreateDoctree) -> None: + """Render an implicit glossary caption as text and keep authored code.""" + sphinx_doctree.set_conf({"extensions": ["myst_parser"]}) + result = sphinx_doctree( + f"""\ +# Glossary + +```{{glossary}} +{term} + An example definition. +``` + +[](<#{term}>) + +{{term}}`{term}` + +[`{term}`](<#{term}>) +""", + "index.md", + ) + doctree = result.get_resolved_doctree("index") + assert not result.warnings, result.warnings + refs = list(doctree.findall(nodes.reference)) + term_id = next(doctree.findall(nodes.term))["ids"][0] + assert [ref["refid"] for ref in refs] == [term_id] * 3 + assert [ref.astext() for ref in refs] == [term] * 3 + assert [any(ref.findall(nodes.literal)) for ref in refs] == [False, False, True] + + def test_project_resolution_beats_local_implicit(sphinx_doctree: CreateDoctree): """`[](#name)` prefers project-wide targets over local implicit names.