lib.roles.email

See also

Registry-aware entry: email in Docutils components.

Email role for docutils.

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

function

function

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

Role for linking to email articles.

Return type:

django_docutils.lib.roles.types.RoleFnReturnValue

Parameters:

• name (str)

• rawtext (str)

• text (str)

• lineno (int)

• inliner (Inliner)

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

• content (str | None)

Examples

me@localhost:

:email:`me@localhost`

Email me:

:email:`Email me <me@localhost>`