lib.roles.url

URL Role for docutils.

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

function

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

https://google.com:

:url:`https://google.com`

Google:

:url:`Google <https://google.com>`

Styled text:

:url:`*Google* <https://google.com>`