docutils.parsers.recommonmark_wrapper.Parser Class Reference

Inheritance diagram for docutils.parsers.recommonmark_wrapper.Parser:

Collaboration diagram for docutils.parsers.recommonmark_wrapper.Parser:

Public Member Functions
	get_transforms (self)
	parse (self, inputstring, document)
	visit_document (self, node)
	visit_text (self, mdnode)

Static Public Attributes
tuple	supported = ('recommonmark', 'commonmark', 'markdown', 'md')
str	config_section = 'recommonmark parser'
tuple	config_section_dependencies = ('parsers',)

Detailed Description

MarkDown parser based on recommonmark.

This parser is provisional:
the API is not settled and may change with any minor Docutils version.

Member Function Documentation

parse()

docutils.parsers.recommonmark_wrapper.Parser.parse	(		self,
			inputstring,
			document
	)

Use the upstream parser and clean up afterwards.

visit_document()

docutils.parsers.recommonmark_wrapper.Parser.visit_document	(		self,
			node
	)

Dummy function to prevent spurious warnings.

cf. https://github.com/readthedocs/recommonmark/issues/177

---

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

• docs/help/help-venv/lib/python3.12/site-packages/docutils/parsers/recommonmark_wrapper.py