:py:mod:`myst_parser.mdit_to_docutils.base` =========================================== .. py:module:: myst_parser.mdit_to_docutils.base .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base :allowtitles: Module Contents --------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`DocutilsRenderer ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer :summary: Functions ~~~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`make_document ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.make_document :summary: * - :py:obj:`token_line ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.token_line :summary: * - :py:obj:`html_meta_to_nodes ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.html_meta_to_nodes :summary: * - :py:obj:`clean_astext ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.clean_astext :summary: * - :py:obj:`default_slugify ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.default_slugify :summary: * - :py:obj:`compute_unique_slug ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.compute_unique_slug :summary: Data ~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`REGEX_SCHEME ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.REGEX_SCHEME :summary: * - :py:obj:`REGEX_URI_TEMPLATE ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.REGEX_URI_TEMPLATE :summary: * - :py:obj:`REGEX_DIRECTIVE_START ` - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.REGEX_DIRECTIVE_START :summary: API ~~~ .. py:function:: make_document(source_path='notset', parser_cls=RSTParser) -> docutils.nodes.document :canonical: myst_parser.mdit_to_docutils.base.make_document .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.make_document .. py:data:: REGEX_SCHEME :canonical: myst_parser.mdit_to_docutils.base.REGEX_SCHEME :value: 'compile(...)' .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.REGEX_SCHEME .. py:data:: REGEX_URI_TEMPLATE :canonical: myst_parser.mdit_to_docutils.base.REGEX_URI_TEMPLATE :value: 'compile(...)' .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.REGEX_URI_TEMPLATE .. py:data:: REGEX_DIRECTIVE_START :canonical: myst_parser.mdit_to_docutils.base.REGEX_DIRECTIVE_START :value: 'compile(...)' .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.REGEX_DIRECTIVE_START .. py:function:: token_line(token: markdown_it.tree.SyntaxTreeNode, default: int | None = None) -> int :canonical: myst_parser.mdit_to_docutils.base.token_line .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.token_line .. py:class:: DocutilsRenderer(parser: markdown_it.main.MarkdownIt) :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer Bases: :py:obj:`markdown_it.renderer.RendererProtocol` .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer .. rubric:: Initialization .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.__init__ .. py:method:: setup_render(options: dict[str, typing.Any], env: collections.abc.MutableMapping[str, typing.Any]) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.setup_render .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.setup_render .. py:property:: sphinx_env :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.sphinx_env :type: sphinx.environment.BuildEnvironment | None .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.sphinx_env .. py:method:: create_warning(message: str, subtype: myst_parser.warnings_.MystWarnings | str, *, wtype: str | None = None, line: int | None = None, append_to: docutils.nodes.Element | None = None) -> docutils.nodes.system_message | None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.create_warning .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.create_warning .. py:method:: render(tokens: collections.abc.Sequence[markdown_it.token.Token], options, md_env: collections.abc.MutableMapping[str, typing.Any]) -> docutils.nodes.document :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render .. py:method:: nested_render_text(text: str, lineno: int, inline: bool = False, temp_root_node: None | docutils.nodes.Element = None, heading_offset: int = 0) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.nested_render_text .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.nested_render_text .. py:method:: current_node_context(node: docutils.nodes.Element, append: bool = False) -> collections.abc.Iterator[None] :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.current_node_context .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.current_node_context .. py:method:: render_children(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_children .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_children .. py:method:: add_line_and_source_path(node, token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.add_line_and_source_path .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.add_line_and_source_path .. py:method:: add_line_and_source_path_r(nodes_: list[docutils.nodes.Element], token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.add_line_and_source_path_r .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.add_line_and_source_path_r .. py:method:: copy_attributes(token: markdown_it.tree.SyntaxTreeNode, node: docutils.nodes.Element, keys: collections.abc.Sequence[str] = ('class', ), *, converters: dict[str, collections.abc.Callable[[str], typing.Any]] | None = None, aliases: dict[str, str] | None = None) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.copy_attributes .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.copy_attributes .. py:method:: update_section_level_state(section: docutils.nodes.section, level: int) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.update_section_level_state .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.update_section_level_state .. py:method:: renderInlineAsText(tokens: list[markdown_it.tree.SyntaxTreeNode]) -> str :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.renderInlineAsText .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.renderInlineAsText .. py:method:: render_paragraph(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_paragraph .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_paragraph .. py:method:: render_inline(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_inline .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_inline .. py:method:: render_text(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_text .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_text .. py:method:: render_bullet_list(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_bullet_list .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_bullet_list .. py:method:: render_ordered_list(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_ordered_list .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_ordered_list .. py:method:: render_list_item(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_list_item .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_list_item .. py:method:: render_em(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_em .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_em .. py:method:: render_softbreak(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_softbreak .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_softbreak .. py:method:: render_hardbreak(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_hardbreak .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_hardbreak .. py:method:: render_strong(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_strong .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_strong .. py:method:: render_blockquote(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_blockquote .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_blockquote .. py:method:: render_alert(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_alert .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_alert .. py:method:: render_alert_title(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_alert_title .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_alert_title .. py:method:: render_hr(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_hr .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_hr .. py:method:: render_code_inline(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_code_inline .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_code_inline .. py:method:: create_highlighted_code_block(text: str, lexer_name: str | None, number_lines: bool = False, lineno_start: int = 1, source: str | None = None, line: int | None = None, node_cls: type[docutils.nodes.Element] = nodes.literal_block, emphasize_lines: list[int] | str | None = None) -> docutils.nodes.Element :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.create_highlighted_code_block .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.create_highlighted_code_block .. py:method:: render_code_block(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_code_block .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_code_block .. py:method:: render_fence(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_fence .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_fence .. py:property:: blocks_mathjax_processing :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.blocks_mathjax_processing :type: bool .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.blocks_mathjax_processing .. py:method:: generate_heading_target(token: markdown_it.tree.SyntaxTreeNode, level: int, node: docutils.nodes.Element, title_node: docutils.nodes.Element) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.generate_heading_target .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.generate_heading_target .. py:method:: render_heading(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_heading .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_heading .. py:method:: render_link(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link .. py:method:: render_link_url(token: markdown_it.tree.SyntaxTreeNode, conversion: None | myst_parser.config.main.UrlSchemeType = None) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_url .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_url .. py:method:: render_link_path(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_path .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_path .. py:method:: render_link_project(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_project .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_project .. py:method:: render_link_anchor(token: markdown_it.tree.SyntaxTreeNode, target: str) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_anchor .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_anchor .. py:method:: render_link_unknown(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_unknown .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_unknown .. py:method:: render_link_inventory(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_inventory .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_link_inventory .. py:method:: get_inventory_matches(*, invs: str | None, domains: str | None, otypes: str | None, target: str | None) -> list[myst_parser.inventory.InvMatch] :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.get_inventory_matches .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.get_inventory_matches .. py:method:: render_html_inline(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_html_inline .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_html_inline .. py:method:: render_html_block(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_html_block .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_html_block .. py:method:: render_image(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_image .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_image .. py:method:: render_span(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_span .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_span .. py:method:: render_front_matter(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_front_matter .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_front_matter .. py:method:: dict_to_fm_field_list(data: dict[str, typing.Any], language_code: str, line: int = 0) -> docutils.nodes.field_list :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.dict_to_fm_field_list .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.dict_to_fm_field_list .. py:method:: render_table(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_table .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_table .. py:method:: render_table_row(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_table_row .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_table_row .. py:method:: render_s(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_s .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_s .. py:method:: render_math_inline(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_inline .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_inline .. py:method:: render_math_inline_double(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_inline_double .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_inline_double .. py:method:: render_math_single(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_single .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_single .. py:method:: render_math_block(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_block .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_block .. py:method:: render_math_block_label(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_block_label .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_math_block_label .. py:method:: render_amsmath(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_amsmath .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_amsmath .. py:method:: render_footnote_ref(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_footnote_ref .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_footnote_ref .. py:method:: render_footnote_reference(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_footnote_reference .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_footnote_reference .. py:method:: render_myst_block_break(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_myst_block_break .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_myst_block_break .. py:method:: render_myst_target(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_myst_target .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_myst_target .. py:method:: render_myst_line_comment(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_myst_line_comment .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_myst_line_comment .. py:method:: render_myst_role(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_myst_role .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_myst_role .. py:method:: render_colon_fence(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_colon_fence .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_colon_fence .. py:method:: render_dl(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_dl .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_dl .. py:method:: render_field_list(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_field_list .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_field_list .. py:method:: render_restructuredtext(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_restructuredtext .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_restructuredtext .. py:method:: render_directive(token: markdown_it.tree.SyntaxTreeNode, name: str, arguments: str, *, additional_options: dict[str, str] | None = None) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_directive .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_directive .. py:method:: run_directive(name: str, first_line: str, content: str, position: int, additional_options: dict[str, str] | None = None) -> list[docutils.nodes.Element] :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.run_directive .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.run_directive .. py:method:: render_substitution_inline(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_substitution_inline .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_substitution_inline .. py:method:: render_substitution_block(token: markdown_it.tree.SyntaxTreeNode) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_substitution_block .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_substitution_block .. py:method:: render_substitution(token: markdown_it.tree.SyntaxTreeNode, inline: bool) -> None :canonical: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_substitution .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.DocutilsRenderer.render_substitution .. py:function:: html_meta_to_nodes(data: dict[str, typing.Any], document: docutils.nodes.document, line: int, reporter: docutils.utils.Reporter) -> list[docutils.nodes.meta | docutils.nodes.system_message] :canonical: myst_parser.mdit_to_docutils.base.html_meta_to_nodes .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.html_meta_to_nodes .. py:function:: clean_astext(node: docutils.nodes.Element) -> str :canonical: myst_parser.mdit_to_docutils.base.clean_astext .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.clean_astext .. py:function:: default_slugify(title: str) -> str :canonical: myst_parser.mdit_to_docutils.base.default_slugify .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.default_slugify .. py:function:: compute_unique_slug(token_tree: markdown_it.tree.SyntaxTreeNode, slugs: collections.abc.Iterable[str], slug_func: None | collections.abc.Callable[[str], str] = None) -> str :canonical: myst_parser.mdit_to_docutils.base.compute_unique_slug .. autodoc2-docstring:: myst_parser.mdit_to_docutils.base.compute_unique_slug