sphinxcontrib.extras_require.directive

The extras-require directive.

Classes:

ExtrasRequireDirective(name, arguments, …)

Directive to show a notice to users that a module, class or function has additional requirements.

Functions:

get_requirements(env, extra, options, content)

Get the requirements for the extras_require node.

make_node_content(requirements, …[, scope])

Create the content of an extras_require node.

validate_requirements(requirements_list)

Validate a list of PEP 508 requirements and format them consistently.
class ExtrasRequireDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Bases: SphinxDirective

Directive to show a notice to users that a module, class or function has additional requirements.

Attributes:

required_arguments

One argument is required, the name of the extra (e.g.

Methods:

run()

Create the extras_require node.
required_arguments = 1

Type:    int

One argument is required, the name of the extra (e.g. “testing”, “docs”)

run()[source]

Create the extras_require node.

Return type

List[Node]

get_requirements(env, extra, options, content)[source]

Get the requirements for the extras_require node.

Parameters
Return type

List[str]

make_node_content(requirements, package_name, extra, scope='module')[source]

Create the content of an extras_require node.

Parameters

  • requirements (List[str]) – List of additional PEP 508 requirements.

  • package_name (str) – The name of the module/package on PyPI.

  • extra (str) – The name of the “extra”.

  • scope (str) – The scope of the additional requirements, e.g. "module", "package". Default 'module'.

Return type

str

Returns

The content of an extras_require node.

validate_requirements(requirements_list)[source]

Validate a list of PEP 508 requirements and format them consistently.

Parameters

requirements_list (List[str]) – List of PEP 508 requirements.

Return type

List[str]

Returns

List of PEP 508 requirements with consistent formatting.