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

Role for <kbd>, the keyboard input element.

Examples

ctrl-t

: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[raw], list[Any]]