Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

## Unreleased

### 🐛 Bug Fixes

- 🐛 Render implicit glossary link captions as plain text (<gh-issue:984>).

## 5.2.0 - 2026-11-10

Heading anchors are now stable and documented:
Expand Down
7 changes: 6 additions & 1 deletion myst_parser/sphinx_ext/myst_refs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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))

Expand Down
30 changes: 30 additions & 0 deletions tests/test_renderers/test_myst_refs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down