sphinx.builders.html.transforms.KeyboardTransform

class documentation

class KeyboardTransform(SphinxPostTransform): (source)

View In Hierarchy

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

Inherited from SphinxPostTransform:

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

Inherited from SphinxTransform (via SphinxPostTransform):

Property app Reference to the :class:`.Sphinx` object.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def is_multiwords_key(self, parts): (source)

Undocumented

Parameters
parts:list[str]Undocumented
Returns
boolUndocumented
def run(self, **kwargs): (source)
overrides sphinx.transforms.post_transforms.SphinxPostTransform.run

Main method of post transforms. Subclasses should override this method instead of ``apply()``.

Parameters
**kwargs:AnyUndocumented
default_priority: int = (source)

Undocumented

formats: tuple[str, ...] = (source)
overrides sphinx.transforms.post_transforms.SphinxPostTransform.formats

Undocumented

multiwords_keys: tuple = (source)

Undocumented

pattern = (source)

Undocumented