sphinx.directives.code.LiteralInclude

class documentation

class LiteralInclude(SphinxDirective):

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.

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