:py:mod:`myst_parser.parsers.docutils_` ======================================= .. py:module:: myst_parser.parsers.docutils_ .. autodoc2-docstring:: myst_parser.parsers.docutils_ :allowtitles: Module Contents --------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`Unset ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.Unset :summary: * - :py:obj:`Parser ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.Parser :summary: * - :py:obj:`SimpleTranslator ` - * - :py:obj:`SimpleWriter ` - Functions ~~~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`attr_to_optparse_option ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.attr_to_optparse_option :summary: * - :py:obj:`create_myst_settings_spec ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.create_myst_settings_spec :summary: * - :py:obj:`create_myst_config ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.create_myst_config :summary: * - :py:obj:`cli_html ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_html :summary: * - :py:obj:`cli_html5 ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_html5 :summary: * - :py:obj:`cli_html5_demo ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_html5_demo :summary: * - :py:obj:`to_html5_demo ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.to_html5_demo :summary: * - :py:obj:`cli_latex ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_latex :summary: * - :py:obj:`cli_xml ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_xml :summary: * - :py:obj:`cli_pseudoxml ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_pseudoxml :summary: * - :py:obj:`visit_rubric_html ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.visit_rubric_html :summary: * - :py:obj:`depart_rubric_html ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.depart_rubric_html :summary: * - :py:obj:`visit_container_html ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.visit_container_html :summary: * - :py:obj:`depart_container_html ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.depart_container_html :summary: Data ~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`DOCUTILS_UNSET ` - .. autodoc2-docstring:: myst_parser.parsers.docutils_.DOCUTILS_UNSET :summary: API ~~~ .. py:class:: Unset :canonical: myst_parser.parsers.docutils_.Unset .. autodoc2-docstring:: myst_parser.parsers.docutils_.Unset .. py:data:: DOCUTILS_UNSET :canonical: myst_parser.parsers.docutils_.DOCUTILS_UNSET :value: 'Unset(...)' .. autodoc2-docstring:: myst_parser.parsers.docutils_.DOCUTILS_UNSET .. py:function:: attr_to_optparse_option(attribute: dataclasses.Field, default: typing.Any, prefix: str = 'myst_') -> tuple[str, list[str], dict[str, typing.Any]] :canonical: myst_parser.parsers.docutils_.attr_to_optparse_option .. autodoc2-docstring:: myst_parser.parsers.docutils_.attr_to_optparse_option .. py:function:: create_myst_settings_spec(config_cls=MdParserConfig, prefix: str = 'myst_') :canonical: myst_parser.parsers.docutils_.create_myst_settings_spec .. autodoc2-docstring:: myst_parser.parsers.docutils_.create_myst_settings_spec .. py:function:: create_myst_config(settings: docutils.frontend.Values, config_cls=MdParserConfig, prefix: str = 'myst_') :canonical: myst_parser.parsers.docutils_.create_myst_config .. autodoc2-docstring:: myst_parser.parsers.docutils_.create_myst_config .. py:class:: Parser(rfc2822=False, inliner=None) :canonical: myst_parser.parsers.docutils_.Parser Bases: :py:obj:`docutils.parsers.rst.Parser` .. autodoc2-docstring:: myst_parser.parsers.docutils_.Parser .. rubric:: Initialization .. autodoc2-docstring:: myst_parser.parsers.docutils_.Parser.__init__ .. py:attribute:: supported :canonical: myst_parser.parsers.docutils_.Parser.supported :type: tuple[str, ...] :value: ('md', 'markdown', 'myst') .. autodoc2-docstring:: myst_parser.parsers.docutils_.Parser.supported .. py:attribute:: settings_spec :canonical: myst_parser.parsers.docutils_.Parser.settings_spec :value: ('MyST options', None) .. autodoc2-docstring:: myst_parser.parsers.docutils_.Parser.settings_spec .. py:attribute:: config_section :canonical: myst_parser.parsers.docutils_.Parser.config_section :value: 'myst parser' .. autodoc2-docstring:: myst_parser.parsers.docutils_.Parser.config_section .. py:attribute:: config_section_dependencies :canonical: myst_parser.parsers.docutils_.Parser.config_section_dependencies :value: ('parsers',) .. autodoc2-docstring:: myst_parser.parsers.docutils_.Parser.config_section_dependencies .. py:attribute:: translate_section_name :canonical: myst_parser.parsers.docutils_.Parser.translate_section_name :value: None .. autodoc2-docstring:: myst_parser.parsers.docutils_.Parser.translate_section_name .. py:method:: get_transforms() :canonical: myst_parser.parsers.docutils_.Parser.get_transforms .. py:method:: parse(inputstring: str, document: docutils.nodes.document) -> None :canonical: myst_parser.parsers.docutils_.Parser.parse .. autodoc2-docstring:: myst_parser.parsers.docutils_.Parser.parse .. py:class:: SimpleTranslator(document) :canonical: myst_parser.parsers.docutils_.SimpleTranslator Bases: :py:obj:`docutils.writers.html5_polyglot.HTMLTranslator` .. py:method:: stylesheet_call(*args, **kwargs) :canonical: myst_parser.parsers.docutils_.SimpleTranslator.stylesheet_call .. py:class:: SimpleWriter() :canonical: myst_parser.parsers.docutils_.SimpleWriter Bases: :py:obj:`docutils.writers.html5_polyglot.Writer` .. py:attribute:: settings_spec :canonical: myst_parser.parsers.docutils_.SimpleWriter.settings_spec :value: 'filter_settings_spec(...)' .. autodoc2-docstring:: myst_parser.parsers.docutils_.SimpleWriter.settings_spec .. py:method:: apply_template() :canonical: myst_parser.parsers.docutils_.SimpleWriter.apply_template .. autodoc2-docstring:: myst_parser.parsers.docutils_.SimpleWriter.apply_template .. py:function:: cli_html(argv: list[str] | None = None) -> None :canonical: myst_parser.parsers.docutils_.cli_html .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_html .. py:function:: cli_html5(argv: list[str] | None = None) :canonical: myst_parser.parsers.docutils_.cli_html5 .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_html5 .. py:function:: cli_html5_demo(argv: list[str] | None = None) :canonical: myst_parser.parsers.docutils_.cli_html5_demo .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_html5_demo .. py:function:: to_html5_demo(inputstring: str, **kwargs) -> str :canonical: myst_parser.parsers.docutils_.to_html5_demo .. autodoc2-docstring:: myst_parser.parsers.docutils_.to_html5_demo .. py:function:: cli_latex(argv: list[str] | None = None) :canonical: myst_parser.parsers.docutils_.cli_latex .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_latex .. py:function:: cli_xml(argv: list[str] | None = None) :canonical: myst_parser.parsers.docutils_.cli_xml .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_xml .. py:function:: cli_pseudoxml(argv: list[str] | None = None) :canonical: myst_parser.parsers.docutils_.cli_pseudoxml .. autodoc2-docstring:: myst_parser.parsers.docutils_.cli_pseudoxml .. py:function:: visit_rubric_html(self, node) :canonical: myst_parser.parsers.docutils_.visit_rubric_html .. autodoc2-docstring:: myst_parser.parsers.docutils_.visit_rubric_html .. py:function:: depart_rubric_html(self, node) :canonical: myst_parser.parsers.docutils_.depart_rubric_html .. autodoc2-docstring:: myst_parser.parsers.docutils_.depart_rubric_html .. py:function:: visit_container_html(self, node: docutils.nodes.Node) :canonical: myst_parser.parsers.docutils_.visit_container_html .. autodoc2-docstring:: myst_parser.parsers.docutils_.visit_container_html .. py:function:: depart_container_html(self, node: docutils.nodes.Node) :canonical: myst_parser.parsers.docutils_.depart_container_html .. autodoc2-docstring:: myst_parser.parsers.docutils_.depart_container_html