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)[source]

Role for <kbd>, the keyboard input element.

Return type:

tuple[list[nodes.raw], list[t.Any]]

Examples

ctrl-t

:kbd:`ctrl-t`