Skip to content
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

Jump to bottom

:kbd: role with Caps Lock rendered incorrectly #8714

Closed
madjxatw opened this issue Jan 20, 2021 · 2 comments
Closed

:kbd: role with Caps Lock rendered incorrectly #8714

madjxatw opened this issue Jan 20, 2021 · 2 comments
Labels
builder:html markup type:bug
Milestone
3.5.0

Comments

@madjxatw
Copy link

Describe the bug

:kbd:`Caps Lock` produces:

<kbd class="kbd compound docutils literal notranslate">
  <kbd class="kbd docutils literal notranslate">Caps</kbd>
  <kbd class="kbd docutils literal notranslate">Lock</kbd>
</kbd>

Expected behavior

<kbd class="kbd docutils literal notranslate">Caps Lock</kbd>

Environment info

  • OS: Debian unstable
  • Python version: 3.9.1
  • Sphinx version: 82ef497
@madjxatw
Copy link
Author

The same issue goes with other keys like "Page Up", "Page Down"...

@tk0miya
Copy link
Member

tk0miya commented Jan 21, 2021

Absolutely. But we have to separate :kbd:`M-x M-s` to two keystrokes....

@tk0miya tk0miya added this to the 3.5.0 milestone Jan 21, 2021
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jan 21, 2021
@tk0miya
Fix sphinx-doc#8714: html: kbd role with "Caps Lock" rendered incorre…
0632b3d 
…ctly
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jan 21, 2021
@tk0miya
Fix sphinx-doc#8714: html: kbd role with "Caps Lock" rendered incorre…
c24513c 
…ctly

`:kbd:` role has to support keys in consist of multiple words (ex. caps
lock, num lock, etc.)
@tk0miya tk0miya mentioned this issue Jan 21, 2021
Merged
tk0miya added a commit to tk0miya/sphinx that referenced this issue Jan 22, 2021
@tk0miya
Fix sphinx-doc#8714: html: kbd role with "Caps Lock" rendered incorre…
59a704c 
…ctly

`:kbd:` role has to support keys in consist of multiple words (ex. caps
lock, num lock, etc.)
tk0miya added a commit that referenced this issue Jan 22, 2021
@tk0miya
Merge pull request #8719 from tk0miya/8714_kbd_capslock
a71028b 
Fix #8714: html: kbd role with "Caps Lock" rendered incorrectly
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
builder:html markup type:bug
Projects
None yet
Milestone
3.5.0
Development

No branches or pull requests
2 participants
@tk0miya @madjxatw