You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
70 lines
1.7 KiB
70 lines
1.7 KiB
"""
|
|
sphinx.builders.html.transforms
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Transforms for HTML builder.
|
|
|
|
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import re
|
|
from typing import Any, Dict
|
|
|
|
from docutils import nodes
|
|
|
|
from sphinx.application import Sphinx
|
|
from sphinx.transforms.post_transforms import SphinxPostTransform
|
|
from sphinx.util.nodes import NodeMatcher
|
|
|
|
|
|
class KeyboardTransform(SphinxPostTransform):
|
|
"""Transform :kbd: role to more detailed form.
|
|
|
|
Before::
|
|
|
|
<literal class="kbd">
|
|
Control-x
|
|
|
|
After::
|
|
|
|
<literal class="kbd">
|
|
<literal class="kbd">
|
|
Control
|
|
-
|
|
<literal class="kbd">
|
|
x
|
|
"""
|
|
default_priority = 400
|
|
builders = ('html',)
|
|
pattern = re.compile(r'(-|\+|\^|\s+)')
|
|
|
|
def run(self, **kwargs: Any) -> None:
|
|
matcher = NodeMatcher(nodes.literal, classes=["kbd"])
|
|
for node in self.document.traverse(matcher): # type: nodes.literal
|
|
parts = self.pattern.split(node[-1].astext())
|
|
if len(parts) == 1:
|
|
continue
|
|
|
|
node.pop()
|
|
while parts:
|
|
key = parts.pop(0)
|
|
node += nodes.literal('', key, classes=["kbd"])
|
|
|
|
try:
|
|
# key separator (ex. -, +, ^)
|
|
sep = parts.pop(0)
|
|
node += nodes.Text(sep)
|
|
except IndexError:
|
|
pass
|
|
|
|
|
|
def setup(app: Sphinx) -> Dict[str, Any]:
|
|
app.add_post_transform(KeyboardTransform)
|
|
|
|
return {
|
|
'version': 'builtin',
|
|
'parallel_read_safe': True,
|
|
'parallel_write_safe': True,
|
|
}
|