myst_parser.parsers.docutils_.Parser Class Reference

Inheritance diagram for myst_parser.parsers.docutils_.Parser:

Collaboration diagram for myst_parser.parsers.docutils_.Parser:

Public Member Functions
	get_transforms (self)
None	parse (self, str inputstring, nodes.document document)

Static Public Attributes
tuple	supported = ("md", "markdown", "myst")
tuple	settings_spec
str	config_section = "myst parser"
tuple	config_section_dependencies = ("parsers",)
	translate_section_name = None

Detailed Description

Docutils parser for Markedly Structured Text (MyST).

Member Function Documentation

parse()

None myst_parser.parsers.docutils_.Parser.parse	(		self,
		str	inputstring,
		nodes.document	document
	)

Parse source text.

:param inputstring: The source string to parse
:param document: The root docutils node to add AST elements to

Member Data Documentation

settings_spec

tuple myst_parser.parsers.docutils_.Parser.settings_spec

static

Initial value:

=  (
        "MyST options",
        None,
        create_myst_settings_spec(),
        *RstParser.settings_spec,
    )

---

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

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