myst_parser.mocking.MockIncludeDirective Class Reference

Public Member Functions
	__init__ (self, DocutilsRenderer renderer, str name, type[Include] klass, list[str] arguments, dict[str, Any] options, list[str] body, int lineno)
list[nodes.Element]	run (self)
	add_name (self, nodes.Element node)

Public Attributes
	renderer
	document
	name
	klass
	arguments
	options
	body
	lineno

Detailed Description

This directive uses a lot of statemachine logic that is not yet mocked.
Therefore, we treat it as a special case (at least for now).

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

Member Function Documentation

add_name()

myst_parser.mocking.MockIncludeDirective.add_name	(		self,
		nodes.Element	node
	)

Append self.options['name'] to node['names'] if it exists.

Also normalize the name string and register it as explicit target.

---

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

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