sphinxcontrib.extras_require.directive
The extras-require
directive.
Classes:
|
Directive to show a notice to users that a module, class or function has additional requirements. |
Functions:
|
Get the requirements for the extras_require node. |
|
Create the content of an extras_require node. |
|
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:
One argument is required, the name of the extra (e.g.
Methods:
run
()Create the extras_require node.
-
get_requirements
(env, extra, options, content)[source] Get the requirements for the extras_require node.