Inheritance diagram for myst_parser._docs.MystExampleDirective:

Collaboration diagram for myst_parser._docs.MystExampleDirective:

Public Member Functions
	run (self)

Public Member Functions inherited from sphinx.util.docutils.SphinxDirective
BuildEnvironment	env (self)

Config	config (self)

tuple[str, int]	get_source_info (self)

None	set_source_info (self, Node node)

str	get_location (self)

list[Node]	parse_content_to_nodes (self, bool allow_section_headings=False)

list[Node]	parse_text_to_nodes (self, str text='', *int offset=-1, bool allow_section_headings=False)

tuple[list[Node], list[system_message]]	parse_inline (self, str text, *int lineno=-1)

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
	content_offset

Public Attributes inherited from sphinx.util.docutils.SphinxDirective
	lineno

	state

	content

Public Attributes inherited from docutils.parsers.rst.Directive
	name

	arguments

	options

	content

	lineno

	content_offset

	block_text

	state

	state_machine

	reporter

Static Public Attributes
bool	has_content = True

dict	option_spec

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

Directive to create an example, showing the source and output.

Member Function Documentation

myst_parser._docs.MystExampleDirective.run ( self )

Run the directive.

dict myst_parser._docs.MystExampleDirective.option_spec

static

Initial value:

=  {
        "alt-output": directives.unchanged,
        "highlight": directives.unchanged,
        # "html": directives.flag,
    }

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