lib.roles.kbd¶

<kbd> (Keyboard Input Element) role for Docutils.

django_docutils.lib.roles.kbd.kbd_role(name, rawtext, text, lineno, inliner, options=None, content=None)

¶

function[source]

function[source]

django_docutils.lib.roles.kbd.kbd_role(name, rawtext, text, lineno, inliner, options=None, content=None)

¶

Role for <kbd>, the keyboard input element.

Examples

>>> node_list, messages = kbd_role(
...     "kbd",
...     ":kbd:`ctrl-t`",
...     "ctrl-t",
...     1,
...     None,  # type: ignore[arg-type]
... )
>>> messages
[]
>>> node_list[0].astext()
'ctrl-t'
>>> node_list[0]["classes"]
['kbd']

:kbd:`ctrl-t`

Parameters:

• name (str)

• rawtext (str)

• text (str)

• lineno (int)

• inliner (Inliner)

• options (dict[str, Any] | None)

• content (str | None)

Return type:

tuple[list[inline], list[Any]]