lib.roles.readthedocs
¶
ReadTheDocs role for Docutils.
- django_docutils.lib.roles.readthedocs.readthedocs_role(name, rawtext, text, lineno, inliner, options=None, content=None)[source]¶
Role for linking to readthedocs.org page.
- Return type:
Examples
:rtd:`django-pipeline`
:rtd:`a rtd site <django-pipeline>`
:rtd:`python-guide:dev/virtualenvs`
:rtd:`about virtualenvs <python-guide:dev/virtualenvs>`