docutils.parsers.rst.directives.misc.Include

class documentation

class Include(Directive):

Include content read from a separate source file.

Content may be parsed by the parser, or included as a literal block. The encoding of the included file can be specified. Only a part of the given file argument may be included by specifying start and end line or text to match before and/or after the text to be used.

Method	`run`	Include a file as part of the content of this reST file.
Class Variable	`final_argument_whitespace`	May the final argument contain whitespace?
Class Variable	`option_spec`	Mapping of option names to validator functions.
Class Variable	`optional_arguments`	Number of optional arguments after the required arguments.
Class Variable	`required_arguments`	Number of required directive arguments.
Class Variable	`standard_include_path`	Undocumented

Inherited from Directive:

Method	`__init__`	Undocumented
Method	`add_name`	Append self.options['name'] to node['names'] if it exists.
Method	`assert_has_content`	Throw an ERROR-level DirectiveError if the directive doesn't have contents.
Method	`debug`	Undocumented
Method	`directive_error`	Return a DirectiveError suitable for being thrown as an exception.
Method	`error`	Undocumented
Method	`info`	Undocumented
Method	`severe`	Undocumented
Method	`warning`	Undocumented
Class Variable	`has_content`	May the directive have content?
Instance Variable	`arguments`	Undocumented
Instance Variable	`block_text`	Undocumented
Instance Variable	`content`	Undocumented
Instance Variable	`content_offset`	Undocumented
Instance Variable	`lineno`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`options`	Undocumented
Instance Variable	`state`	Undocumented
Instance Variable	`state_machine`	Undocumented

def run(self):

overrides docutils.parsers.rst.Directive.run

Include a file as part of the content of this reST file.

Depending on the options, the file (or a clipping) is converted to nodes and returned or inserted into the input stream.

final_argument_whitespace: bool =

overrides docutils.parsers.rst.Directive.final_argument_whitespace

May the final argument contain whitespace?

option_spec =

overrides docutils.parsers.rst.Directive.option_spec

Mapping of option names to validator functions.

optional_arguments: int =

overrides docutils.parsers.rst.Directive.optional_arguments

Number of optional arguments after the required arguments.

required_arguments: int =

overrides docutils.parsers.rst.Directive.required_arguments

Number of required directive arguments.

standard_include_path =

Undocumented