docutils.parsers.rst.directives.misc.Include Class Reference

Inheritance diagram for docutils.parsers.rst.directives.misc.Include:

Collaboration diagram for docutils.parsers.rst.directives.misc.Include:

Public Member Functions
	run (self)
Public Member Functions inherited from docutils.parsers.rst.Directive
	__init__ (self, name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
	directive_error (self, level, message)
	debug (self, message)
	info (self, message)
	warning (self, message)
	error (self, message)
	severe (self, message)
	assert_has_content (self)
	add_name (self, node)

Public Attributes
	name
	options
	lineno
	content_offset
	block_text
	state
	state_machine
Public Attributes inherited from docutils.parsers.rst.Directive
	name
	arguments
	options
	content
	lineno
	content_offset
	block_text
	state
	state_machine
	reporter

Static Public Attributes
int	required_arguments = 1
int	optional_arguments = 0
bool	final_argument_whitespace = True
dict	option_spec
str	standard_include_path = Path(states.__file__).parent / 'include'
Static Public Attributes inherited from docutils.parsers.rst.Directive
int	required_arguments = 0
int	optional_arguments = 0
bool	final_argument_whitespace = False
	option_spec = None
bool	has_content = False

Detailed Description

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.

https://docutils.sourceforge.io/docs/ref/rst/directives.html#including-an-external-document-fragment

Member Function Documentation

run()

docutils.parsers.rst.directives.misc.Include.run

(

self

)

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.

Reimplemented from docutils.parsers.rst.Directive.

Member Data Documentation

option_spec

dict docutils.parsers.rst.directives.misc.Include.option_spec

static

Initial value:

=  {'literal': directives.flag,
                   'code': directives.unchanged,
                   'encoding': directives.encoding,
                   'parser': directives.parser_name,
                   'tab-width': int,
                   'start-line': int,
                   'end-line': int,
                   'start-after': directives.unchanged_required,
                   'end-before': directives.unchanged_required,
                   # ignored except for 'literal' or 'code':
                   'number-lines': directives.unchanged,  # integer or None
                   'class': directives.class_option,
                   'name': directives.unchanged}

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/parsers/rst/directives/misc.py