sphinx.directives.code

module documentation

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable logger Undocumented
Class ​Code​Block Directive for a code block with special highlighting or line numbering settings.
Class ​Highlight Directive to set the highlighting language for code blocks, as well as the threshold for line numbers.
Class ​Literal​Include Like .. include:: :literal:, but only warns if the include file is not found, and does not raise errors. Also has several options for selecting what to include.
Class ​Literal​Include​Reader Undocumented
Function container​_wrapper Undocumented
Function dedent​_lines Undocumented
Function setup Undocumented
logger =

Undocumented

def container_wrapper(directive, literal_node, caption):

Undocumented

Parameters
directive:SphinxDirectiveUndocumented
literal​_node:NodeUndocumented
caption:strUndocumented
Returns
nodes.containerUndocumented
def dedent_lines(lines, dedent, location=None):

Undocumented

Parameters
lines:List[str]Undocumented
dedent:intUndocumented
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
def setup(app):

Undocumented

Parameters
app:SphinxUndocumented
Returns
Dict[str, Any]Undocumented