sphinx.directives.patches.Code

class documentation

class Code(SphinxDirective): (source)

View In Hierarchy

Parse and mark up content of a code block. This is compatible with docutils' :rst:dir:`code` directive.

Method run Undocumented
Class Variable has_content Undocumented
Class Variable option_spec Undocumented
Class Variable optional_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
has_content: bool = (source)

Undocumented

option_spec: OptionSpec = (source)

Undocumented

optional_arguments: int = (source)

Undocumented