lib.roles.file

File role for Docutils.

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

function

Role for files.

Examples

📄 ./path/to/moo:

:file:`./path/to/moo`

📁 ./path/to/moo/:

:file:`./path/to/moo/`

Parameters:

• name (str)

• rawtext (str)

• text (str)

• lineno (int)

• inliner (Inliner)

• options (dict[str, Any] | None)

• content (str | None)

Return type:

tuple[list[emphasis], list[Any]]

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

function

Role for manifests (package.json, file outputs).

Examples

📄 package.json:

:manifest:`package.json`

Parameters:

• name (str)

• rawtext (str)

• text (str)

• lineno (int)

• inliner (Inliner)

• options (dict[str, Any] | None)

• content (str | None)

Return type:

tuple[list[emphasis], list[Any]]

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

function

Role for executables.

Examples

📄 ./path/to/webpack:

:exe:`./path/to/webpack`

Parameters:

• name (str)

• rawtext (str)

• text (str)

• lineno (int)

• inliner (Inliner)

• options (dict[str, Any] | None)

• content (str | None)

Return type:

tuple[list[emphasis], list[Any]]