sphinx.domains.python.PyCurrentModule

class documentation

class PyCurrentModule(SphinxDirective): (source)

View In Hierarchy

This directive is just to tell Sphinx that we're documenting stuff in module foo, but links to module foo won't lead here.

Method run Undocumented
Class Variable final_argument_whitespace Undocumented
Class Variable has_content Undocumented
Class Variable option_spec Undocumented
Class Variable optional_arguments Undocumented
Class Variable required_arguments Undocumented

Inherited from SphinxDirective:

Method get_location Get current location info for logging.
Method get_source_info Get source and line number.
Method set_source_info Set source and line number to the node.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def run(self): (source)

Undocumented

Returns
list[Node]Undocumented
final_argument_whitespace: bool = (source)

Undocumented

has_content: bool = (source)

Undocumented

option_spec: OptionSpec = (source)

Undocumented

optional_arguments: int = (source)

Undocumented

required_arguments: int = (source)

Undocumented