sphinx.builders.html.transforms.KeyboardTransform

class documentation

class KeyboardTransform(SphinxPostTransform):

Transform :kbd: role to more detailed form.

Before:

<literal class="kbd">
    Control-x

After:

<literal class="kbd compound">
    <literal class="kbd">
        Control
    -
    <literal class="kbd">
        x

Method	`is_multiwords_key`	Undocumented
Method	`run`	Main method of post transforms.
Class Variable	`default_priority`	Undocumented
Class Variable	`formats`	Undocumented
Class Variable	`multiwords_keys`	Undocumented
Class Variable	`pattern`	Undocumented

Method	`apply`	Undocumented
Method	`is_supported`	Check this transform working for current builder.
Class Variable	`builders`	Undocumented

Property	`app`	Reference to the `.Sphinx` object.
Property	`config`	Reference to the `.Config` object.
Property	`env`	Reference to the `.BuildEnvironment` object.

def is_multiwords_key(self, parts):

Undocumented

def run(self, **kwargs):

overrides sphinx.transforms.post_transforms.SphinxPostTransform.run

Main method of post transforms.

Subclasses should override this method instead of apply().

Parameters
**kwargs:`Any`	Undocumented

default_priority: int =

Undocumented

formats: tuple[str, ...] =

overrides sphinx.transforms.post_transforms.SphinxPostTransform.formats

Undocumented

multiwords_keys: tuple =

Undocumented

pattern =

Undocumented