lib.roles.pypi¶

PyPI (Python Package Index) role for docutils.

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

¶

function[source]

function[source]

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

¶

Role for linking to PyPI (Python Package Index) 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

libsass:

:pypi:`libsass`

a pypi package:

:pypi:`a pypi package <libsass>`