sphinx.directives.other.Include

class documentation

class Include(BaseInclude, SphinxDirective): (source)

View In Hierarchy

Like the standard "Include" directive, but interprets absolute paths "correctly", i.e. relative to source directory.

Method run 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