sphinxcontrib.requirements_txt

Sphinx extension: requirements-txt

sphinxcontrib.requirements_txt.setup(app: Sphinx) → None

Set up.

Parameters:

app (Sphinx) –

Return type:

None

This file is generated by setuptools-generate. The information comes from pyproject.toml. It provide some metainfo for docs/conf.py to build documents and help2man to build man pages.

Directive

class sphinxcontrib.requirements_txt.directive.RequirementsDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Requirementsdirective.

has_content = True

May the directive have content?

option_spec = {'template': <class 'str'>, 'title': <class 'str'>}

Mapping of option names to validator functions.

optional_arguments = 0

Number of optional arguments after the required arguments.

run() → list[Node]

Run.

Return type:

list[Node]

sphinxcontrib.requirements_txt.directive.parse(file: str) → list[str]

Parse requirements.txt. text will be displayed as a url, other will be displayed normally.

Parameters:

file (str) –

Return type:

list[str]