IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Closes #3160: Use <kbd> tag for :kbd: role in html writers

Browse Source
This commit is contained in:
David Lechner 2017-10-30 10:22:11 -05:00
parent 215be8e5bd
commit 831f89a687
5 changed files with 27 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -73,6 +73,7 @@ Features removed
Bugs fixed Bugs fixed
---------- ----------
* #3160: Why doesn't Sphinx translate :kbd: roles to HTML's <kbd> tags?
* #3882: Update the order of files for HTMLHelp and QTHelp * #3882: Update the order of files for HTMLHelp and QTHelp
* #3962: sphinx-apidoc does not recognize implicit namespace packages correctly * #3962: sphinx-apidoc does not recognize implicit namespace packages correctly

17
sphinx/writers/html.py
View File

@ -491,14 +491,21 @@ class HTMLTranslator(BaseTranslator):
# overwritten # overwritten
def visit_literal(self, node): def visit_literal(self, node):
# type: (nodes.Node) -> None # type: (nodes.Node) -> None
self.body.append(self.starttag(node, 'code', '', if 'kbd' in node['classes']:
CLASS='docutils literal')) self.body.append(self.starttag(node, 'kbd', '',
self.protect_literal_text += 1 CLASS='docutils literal'))
else:
self.body.append(self.starttag(node, 'code', '',
CLASS='docutils literal'))
self.protect_literal_text += 1
def depart_literal(self, node): def depart_literal(self, node):
# type: (nodes.Node) -> None # type: (nodes.Node) -> None
self.protect_literal_text -= 1 if 'kbd' in node['classes']:
self.body.append('</code>') self.body.append('</kbd>')
else:
self.protect_literal_text -= 1
self.body.append('</code>')
def visit_productionlist(self, node): def visit_productionlist(self, node):
# type: (nodes.Node) -> None # type: (nodes.Node) -> None

17
sphinx/writers/html5.py
View File

@ -437,14 +437,21 @@ class HTML5Translator(BaseTranslator):
# overwritten # overwritten
def visit_literal(self, node): def visit_literal(self, node):
# type: (nodes.Node) -> None # type: (nodes.Node) -> None
self.body.append(self.starttag(node, 'code', '', if 'kbd' in node['classes']:
CLASS='docutils literal')) self.body.append(self.starttag(node, 'kbd', '',
self.protect_literal_text += 1 CLASS='docutils literal'))
else:
self.body.append(self.starttag(node, 'code', '',
CLASS='docutils literal'))
self.protect_literal_text += 1
def depart_literal(self, node): def depart_literal(self, node):
# type: (nodes.Node) -> None # type: (nodes.Node) -> None
self.protect_literal_text -= 1 if 'kbd' in node['classes']:
self.body.append('</code>') self.body.append('</kbd>')
else:
self.protect_literal_text -= 1
self.body.append('</code>')
def visit_productionlist(self, node): def visit_productionlist(self, node):
# type: (nodes.Node) -> None # type: (nodes.Node) -> None

2
tests/test_build_html.py
View File

@ -238,7 +238,7 @@ def test_static_output(app):
(".//li/strong", r'^command\\n$'), (".//li/strong", r'^command\\n$'),
(".//li/strong", r'^program\\n$'), (".//li/strong", r'^program\\n$'),
(".//li/em", r'^dfn\\n$'), (".//li/em", r'^dfn\\n$'),
(".//li/code/span[@class='pre']", r'^kbd\\n$'), (".//li/kbd", r'^kbd\\n$'),
(".//li/span", u'File \N{TRIANGULAR BULLET} Close'), (".//li/span", u'File \N{TRIANGULAR BULLET} Close'),
(".//li/code/span[@class='pre']", '^a/$'), (".//li/code/span[@class='pre']", '^a/$'),
(".//li/code/em/span[@class='pre']", '^varpart$'), (".//li/code/em/span[@class='pre']", '^varpart$'),

2
tests/test_build_html5.py
View File

@ -119,7 +119,7 @@ def cached_etree_parse():
(".//li/p/strong", r'^command\\n$'), (".//li/p/strong", r'^command\\n$'),
(".//li/p/strong", r'^program\\n$'), (".//li/p/strong", r'^program\\n$'),
(".//li/p/em", r'^dfn\\n$'), (".//li/p/em", r'^dfn\\n$'),
(".//li/p/code/span[@class='pre']", r'^kbd\\n$'), (".//li/p/kbd", r'^kbd\\n$'),
(".//li/p/span", u'File \N{TRIANGULAR BULLET} Close'), (".//li/p/span", u'File \N{TRIANGULAR BULLET} Close'),
(".//li/p/code/span[@class='pre']", '^a/$'), (".//li/p/code/span[@class='pre']", '^a/$'),
(".//li/p/code/em/span[@class='pre']", '^varpart$'), (".//li/p/code/em/span[@class='pre']", '^varpart$'),