sphinx.domains.python.PyModule

class documentation

class PyModule(SphinxDirective):

View In Hierarchy

Directive to mark description of a new module.
Method make​_old​_id Generate old styled node_id.
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 .Config object.
Property env Reference to the .BuildEnvironment object.
def make_old_id(self, name):

Generate old styled node_id.

Old styled node_id is incompatible with docutils' node_id. It can contain dots and hyphens.

Note

Old styled node_id was mainly used until Sphinx-3.0.

Parameters
name:strUndocumented
Returns
strUndocumented
def run(self):

Undocumented

Returns
List[Node]Undocumented
final_argument_whitespace: bool =

Undocumented

has_content: bool =

Undocumented

option_spec: OptionSpec =

Undocumented

optional_arguments: int =

Undocumented

required_arguments: int =

Undocumented