sphinx.directives.code

module documentation
(source)

Undocumented

Class CodeBlock 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 LiteralInclude 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 LiteralIncludeReader Undocumented
Function container_wrapper Undocumented
Function dedent_lines Undocumented
Function setup Undocumented
Variable logger Undocumented
def container_wrapper(directive, literal_node, caption): (source)

Undocumented

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

Undocumented

Parameters
lines:list[str]Undocumented
dedent:int|NoneUndocumented
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
logger = (source)

Undocumented