myst_parser._docs.MystConfigDirective Class Reference

Inheritance diagram for myst_parser._docs.MystConfigDirective:

Collaboration diagram for myst_parser._docs.MystConfigDirective:

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)

Static Public Attributes
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

Additional Inherited Members
Static Public Member Functions inherited from myst_parser._docs._ConfigBase
	table_header ()
	field_default (value)
	field_type (field)
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

Member Function Documentation

run()

myst_parser._docs.MystConfigDirective.run

(

self

)

Run the directive.

Reimplemented from docutils.parsers.rst.Directive.

Member Data Documentation

option_spec

dict myst_parser._docs.MystConfigDirective.option_spec

static

Initial value:

=  {
        "sphinx": directives.flag,
        "extensions": directives.flag,
        "scope": lambda x: directives.choice(x, ["global", "local"]),
    }

---

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

• docs/help/help-venv/lib/python3.12/site-packages/myst_parser/_docs.py