Skip to content

Group nodes generated by :kbd: role and add class to separators (#13876) #13877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Group nodes generated by :kbd: role and add class to separators (#13876) #13877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8781d36
Group nodes generated by :kbd: role and add class to separators (#13876)
brechtm Sep 5, 2025
9b0aee6
Merge branch 'master' into fix-kbd-regression-13876
AA-Turner Oct 5, 2025
5b4de9e
Merge branch 'master' into fix-kbd-regression-13876
AA-Turner Oct 5, 2025
bf31591
Only wrap `<kbd>` nodes when multiple elements are present
AA-Turner Oct 5, 2025
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
4 changes: 4 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,10 @@ Bugs fixed
* #13929: Duplicate equation label warnings now have a new warning
sub-type, ``ref.equation``.
Patch by Jared Dillard.
* #13876: Restore the ``compound`` class for groups of nodes generated
by the :rst:role:`kbd` role, and add the ``kbd-sep`` class to separators
within the group.
Patch by Brecht Machiels.


Testing
Expand Down
7 changes: 4 additions & 3 deletions sphinx/roles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,8 @@ def run(self) -> tuple[list[Node], list[system_message]]:
if len(parts) == 1 or self._is_multi_word_key(parts):
return [nodes.literal(self.rawtext, self.text, classes=classes)], []

compound: list[Node] = []
compound = nodes.literal(self.rawtext, classes=classes)
compound['classes'].append('compound')
while parts:
if self._is_multi_word_key(parts):
key = ''.join(parts[:3])
Expand All @@ -509,9 +510,9 @@ def run(self) -> tuple[list[Node], list[system_message]]:
except IndexError:
break
else:
compound.append(nodes.Text(sep))
compound.append(nodes.inline(sep, sep, classes=['kbd-sep']))

return compound, []
return [compound], []

@staticmethod
def _is_multi_word_key(parts: list[str]) -> bool:
Expand Down
44 changes: 30 additions & 14 deletions tests/test_markup/test_markup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,16 +341,20 @@ def get_verifier(verify, verify_re):
':kbd:`Control+X`',
(
'<p>'
'<kbd class="kbd compound docutils literal notranslate">'
'<kbd class="kbd docutils literal notranslate">Control</kbd>'
'+'
'<span class="kbd-sep">+</span>'
'<kbd class="kbd docutils literal notranslate">X</kbd>'
'</kbd>'
'</p>'
),
(
'\\sphinxAtStartPar\n'
'\\sphinxkeyboard{\\sphinxupquote{'
'\\sphinxkeyboard{\\sphinxupquote{Control}}'
'+'
'\\DUrole{kbd-sep}{+}'
'\\sphinxkeyboard{\\sphinxupquote{X}}'
'}}'
),
),
(
Expand All @@ -359,16 +363,20 @@ def get_verifier(verify, verify_re):
':kbd:`Alt+^`',
(
'<p>'
'<kbd class="kbd compound docutils literal notranslate">'
'<kbd class="kbd docutils literal notranslate">Alt</kbd>'
'+'
'<span class="kbd-sep">+</span>'
'<kbd class="kbd docutils literal notranslate">^</kbd>'
'</kbd>'
'</p>'
),
(
'\\sphinxAtStartPar\n'
'\\sphinxkeyboard{\\sphinxupquote{'
'\\sphinxkeyboard{\\sphinxupquote{Alt}}'
'+'
'\\DUrole{kbd-sep}{+}'
'\\sphinxkeyboard{\\sphinxupquote{\\textasciicircum{}}}'
'}}'
),
),
(
Expand All @@ -377,24 +385,28 @@ def get_verifier(verify, verify_re):
':kbd:`M-x M-s`',
(
'<p>'
'<kbd class="kbd compound docutils literal notranslate">'
'<kbd class="kbd docutils literal notranslate">M</kbd>'
'-'
'<span class="kbd-sep">-</span>'
'<kbd class="kbd docutils literal notranslate">x</kbd>'
' '
'<span class="kbd-sep"> </span>'
'<kbd class="kbd docutils literal notranslate">M</kbd>'
'-'
'<span class="kbd-sep">-</span>'
'<kbd class="kbd docutils literal notranslate">s</kbd>'
'</kbd>'
'</p>'
),
(
'\\sphinxAtStartPar\n'
'\\sphinxkeyboard{\\sphinxupquote{'
'\\sphinxkeyboard{\\sphinxupquote{M}}'
'\\sphinxhyphen{}'
'\\DUrole{kbd-sep}{\\sphinxhyphen{}}'
'\\sphinxkeyboard{\\sphinxupquote{x}}'
' '
'\\DUrole{kbd-sep}{ }'
'\\sphinxkeyboard{\\sphinxupquote{M}}'
'\\sphinxhyphen{}'
'\\DUrole{kbd-sep}{\\sphinxhyphen{}}'
'\\sphinxkeyboard{\\sphinxupquote{s}}'
'}}'
),
),
(
Expand Down Expand Up @@ -424,20 +436,24 @@ def get_verifier(verify, verify_re):
':kbd:`⌘+⇧+M`',
(
'<p>'
'<kbd class="kbd compound docutils literal notranslate">'
'<kbd class="kbd docutils literal notranslate">⌘</kbd>'
'+'
'<span class="kbd-sep">+</span>'
'<kbd class="kbd docutils literal notranslate">⇧</kbd>'
'+'
'<span class="kbd-sep">+</span>'
'<kbd class="kbd docutils literal notranslate">M</kbd>'
'</kbd>'
'</p>'
),
(
'\\sphinxAtStartPar\n'
'\\sphinxkeyboard{\\sphinxupquote{'
'\\sphinxkeyboard{\\sphinxupquote{⌘}}'
'+'
'\\DUrole{kbd-sep}{+}'
'\\sphinxkeyboard{\\sphinxupquote{⇧}}'
'+'
'\\DUrole{kbd-sep}{+}'
'\\sphinxkeyboard{\\sphinxupquote{M}}'
'}}'
),
),
(
Expand Down
Loading