lib.roles.readthedocs

ReadTheDocs role for Docutils.

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

function

Role for linking to readthedocs.org page.

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

django-pipeline:

:rtd:`django-pipeline`

a rtd site:

:rtd:`a rtd site <django-pipeline>`

python-guide:dev/virtualenvs:

:rtd:`python-guide:dev/virtualenvs`

about virtualenvs:

:rtd:`about virtualenvs <python-guide:dev/virtualenvs>`