Inheritance diagram for myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer:

Collaboration diagram for myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer:

Public Member Functions
BuildEnvironment	sphinx_env (self)

None	render_link_project (self, SyntaxTreeNode token)

None	render_link_path (self, SyntaxTreeNode token)

None	render_link_unknown (self, SyntaxTreeNode token)

list[inventory.InvMatch]	get_inventory_matches (self, *str\|None invs, str\|None domains, str\|None otypes, str\|None target)

None	render_math_block_label (self, SyntaxTreeNode token)

None	render_amsmath (self, SyntaxTreeNode token)

nodes.target	add_math_target (self, nodes.math_block node)

Public Member Functions inherited from myst_parser.mdit_to_docutils.base.DocutilsRenderer
None	__init__ (self, MarkdownIt parser)

	__getattr__ (self, str name)

None	setup_render (self, dict[str, Any] options, MutableMapping[str, Any] env)

nodes.system_message\|None	create_warning (self, str message, MystWarnings\|str subtype, *str\|None wtype=None, int\|None line=None, nodes.Element\|None append_to=None)

nodes.document	render (self, Sequence[Token] tokens, options, MutableMapping[str, Any] md_env)

None	nested_render_text (self, str text, int lineno, bool inline=False, None\|nodes.Element temp_root_node=None, int heading_offset=0)

Iterator[None]	current_node_context (self, nodes.Element node, bool append=False)

None	render_children (self, SyntaxTreeNode token)

None	add_line_and_source_path (self, node, SyntaxTreeNode token)

None	add_line_and_source_path_r (self, list[nodes.Element] nodes_, SyntaxTreeNode token)

None	copy_attributes (self, SyntaxTreeNode token, nodes.Element node, Sequence[str] keys=("class",), *dict[str, Callable[[str], Any]]\|None converters=None, dict[str, str]\|None aliases=None)

None	update_section_level_state (self, nodes.section section, int level)

str	renderInlineAsText (self, list[SyntaxTreeNode] tokens)

None	render_paragraph (self, SyntaxTreeNode token)

None	render_inline (self, SyntaxTreeNode token)

None	render_text (self, SyntaxTreeNode token)

None	render_bullet_list (self, SyntaxTreeNode token)

None	render_ordered_list (self, SyntaxTreeNode token)

None	render_list_item (self, SyntaxTreeNode token)

None	render_em (self, SyntaxTreeNode token)

None	render_softbreak (self, SyntaxTreeNode token)

None	render_hardbreak (self, SyntaxTreeNode token)

None	render_strong (self, SyntaxTreeNode token)

None	render_blockquote (self, SyntaxTreeNode token)

None	render_hr (self, SyntaxTreeNode token)

None	render_code_inline (self, SyntaxTreeNode token)

nodes.Element	create_highlighted_code_block (self, str text, str\|None lexer_name, bool number_lines=False, int lineno_start=1, str\|None source=None, int\|None line=None, type[nodes.Element] node_cls=nodes.literal_block, list[int]\|str\|None emphasize_lines=None)

None	render_code_block (self, SyntaxTreeNode token)

None	render_fence (self, SyntaxTreeNode token)

bool	blocks_mathjax_processing (self)

None	generate_heading_target (self, SyntaxTreeNode token, int level, nodes.Element node, nodes.Element title_node)

None	render_heading (self, SyntaxTreeNode token)

None	render_link (self, SyntaxTreeNode token)

None	render_link_url (self, SyntaxTreeNode token, None\|UrlSchemeType conversion=None)

None	render_link_anchor (self, SyntaxTreeNode token, str target)

None	render_link_inventory (self, SyntaxTreeNode token)

None	render_html_inline (self, SyntaxTreeNode token)

None	render_html_block (self, SyntaxTreeNode token)

None	render_image (self, SyntaxTreeNode token)

None	render_span (self, SyntaxTreeNode token)

None	render_front_matter (self, SyntaxTreeNode token)

nodes.field_list	dict_to_fm_field_list (self, dict[str, Any] data, str language_code, int line=0)

None	render_table (self, SyntaxTreeNode token)

None	render_table_row (self, SyntaxTreeNode token)

None	render_s (self, SyntaxTreeNode token)

None	render_math_inline (self, SyntaxTreeNode token)

None	render_math_inline_double (self, SyntaxTreeNode token)

None	render_math_single (self, SyntaxTreeNode token)

None	render_math_block (self, SyntaxTreeNode token)

None	render_footnote_ref (self, SyntaxTreeNode token)

None	render_footnote_reference (self, SyntaxTreeNode token)

None	render_myst_block_break (self, SyntaxTreeNode token)

None	render_myst_target (self, SyntaxTreeNode token)

None	render_myst_line_comment (self, SyntaxTreeNode token)

None	render_myst_role (self, SyntaxTreeNode token)

None	render_colon_fence (self, SyntaxTreeNode token)

None	render_dl (self, SyntaxTreeNode token)

None	render_field_list (self, SyntaxTreeNode token)

None	render_restructuredtext (self, SyntaxTreeNode token)

None	render_directive (self, SyntaxTreeNode token, str name, str arguments, *dict[str, str]\|None additional_options=None)

list[nodes.Element]	run_directive (self, str name, str first_line, str content, int position, dict[str, str]\|None additional_options=None)

None	render_substitution_inline (self, SyntaxTreeNode token)

None	render_substitution_block (self, SyntaxTreeNode token)

None	render_substitution (self, SyntaxTreeNode token, bool inline)

Public Attributes
	sphinx_env

Public Attributes inherited from myst_parser.mdit_to_docutils.base.DocutilsRenderer
	md

	rules

	md_env

	md_options

	document

	current_node

	language_module_rst

Protected Member Functions
	_process_wrap_node (self, nodes.Element wrap_node, SyntaxTreeNode token, bool explicit, list[str] classes, str path_dest)

str	_handle_relative_docs (self, str destination)

str	_random_label (self)

Protected Member Functions inherited from myst_parser.mdit_to_docutils.base.DocutilsRenderer
None	_render_tokens (self, list[Token] tokens)

None	_render_initialise (self)

None	_render_finalise (self)

Additional Inherited Members
Static Protected Member Functions inherited from myst_parser.mdit_to_docutils.base.DocutilsRenderer
list[int]	_parse_linenos (str emphasize_lines, int num_lines)

Protected Attributes inherited from myst_parser.mdit_to_docutils.base.DocutilsRenderer
	_heading_offset

	_level_to_section

	_heading_slugs

	_inventories

Detailed Description

A markdown-it-py renderer to populate (in-place) a `docutils.document` AST.

This is sub-class of `DocutilsRenderer` that handles sphinx specific aspects,
such as cross-referencing.

Member Function Documentation

◆ _handle_relative_docs()

str myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer._handle_relative_docs	(		self,
		str	destination
	)

protected

Make the path relative to an "including" document

This is set when using the `relative-docs` option of the MyST `include` directive

◆ _process_wrap_node()

myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer._process_wrap_node	(		self,
		nodes.Element	wrap_node,
		SyntaxTreeNode	token,
		bool	explicit,
		list[str]	classes,
		str	path_dest
	)

protected

Process a wrap node, which is a node that wraps a link.

◆ get_inventory_matches()

list[inventory.InvMatch] myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.get_inventory_matches	(		self,
		*str \| None	invs,
		str \| None	domains,
		str \| None	otypes,
		str \| None	target
	)

Return inventory matches.

This will be overridden for sphinx, to use intersphinx config.

Reimplemented from myst_parser.mdit_to_docutils.base.DocutilsRenderer.

◆ render_amsmath()

None myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_amsmath	(		self,
		SyntaxTreeNode	token
	)

Renderer for the amsmath extension.

Reimplemented from myst_parser.mdit_to_docutils.base.DocutilsRenderer.

◆ render_link_path()

None myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_link_path	(		self,
		SyntaxTreeNode	token
	)

Render a link token like `<path:...>`.

Reimplemented from myst_parser.mdit_to_docutils.base.DocutilsRenderer.

◆ render_link_project()

None myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_link_project	(		self,
		SyntaxTreeNode	token
	)

Render a link token like `<project:...>`.

Reimplemented from myst_parser.mdit_to_docutils.base.DocutilsRenderer.

◆ render_link_unknown()

None myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_link_unknown	(		self,
		SyntaxTreeNode	token
	)

Render link token `[text](link "title")`,
where the link has not been identified as an external URL.

Reimplemented from myst_parser.mdit_to_docutils.base.DocutilsRenderer.

◆ render_math_block_label()

None myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_math_block_label	(		self,
		SyntaxTreeNode	token
	)

Render math with referenceable labels, e.g. ``$a=1$ (label)``.

Reimplemented from myst_parser.mdit_to_docutils.base.DocutilsRenderer.

◆ sphinx_env()

BuildEnvironment myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.sphinx_env ( self )

Reimplemented from myst_parser.mdit_to_docutils.base.DocutilsRenderer.

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

docs/help/help-venv/lib/python3.12/site-packages/myst_parser/mdit_to_docutils/sphinx_.py

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _handle_relative_docs()

◆ _process_wrap_node()

◆ get_inventory_matches()

◆ render_amsmath()

◆ render_link_path()

◆ render_link_project()

◆ render_link_unknown()

◆ render_math_block_label()

◆ sphinx_env()