lib.roles.twitter

See also

Registry-aware entry: twitter in Docutils components.

Twitter role for docutils.

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

function

function

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

Role for linking to twitter 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

@username:

:twitter:`@username`

follow me on twitter:

:twitter:`follow me on twitter <@username>`