.. _f-sphinxmconvertdocsphinxhelper: module ``helpgen.sphinxm_convert_doc_sphinx_helper`` ==================================================== .. inheritance-diagram:: pyquickhelper.helpgen.sphinxm_convert_doc_sphinx_helper Short summary +++++++++++++ module ``pyquickhelper.helpgen.sphinxm_convert_doc_sphinx_helper`` Helpers to convert docstring to various format. :githublink:`%|py|5` Classes +++++++ +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +================================================================================================================================================+==========================================================================================================================================+ | :class:`_AdditionalVisitDepart ` | Additional visitors and departors. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_CustomBuildEnvironment ` | Overrides some functionalities of `BuildEnvironment `_. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_CustomSphinx ` | Custom :epkg:`Sphinx` application to avoid using disk. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_MemoryBuilder ` | Builds :epkg:`HTML` output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`_WriterWithCustomDirectives ` | Common class to :class:`HTMLWriterWithCustomDirectives` and :class:`RSTWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DocTreeTranslatorWithCustomDirectives ` | See :class:`HTMLWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`DocTreeWriterWithCustomDirectives ` | This :epkg:`docutils` writer creates a doctree writer with custom directives implemented in this module. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`HTMLTranslatorWithCustomDirectives ` | See :class:`HTMLWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`HTMLWriterWithCustomDirectives ` | This :epkg:`docutils` writer extends the HTML writer with custom directives implemented in this module, :class:`RunPythonDirective`, ... | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`LatexTranslatorWithCustomDirectives ` | See :class:`LatexWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`LatexWriterWithCustomDirectives ` | This :epkg:`docutils` writer extends the :epkg:`Latex` writer with custom directives implemented in this module. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MDTranslatorWithCustomDirectives ` | See :class:`HTMLWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MDWriterWithCustomDirectives ` | This :epkg:`docutils` writer extends the :epkg:`MD` writer with custom directives implemented in this module. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryDocTreeBuilder ` | Builds doctree output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryHTMLBuilder ` | Builds :epkg:`HTML` output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryLatexBuilder ` | Builds :epkg:`Latex` output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryMDBuilder ` | Builds :epkg:`MD` output in memory. The API is defined by the page :epkg:`builderapi`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`MemoryRSTBuilder ` | Builds :epkg:`RST` output in memory. The API is defined by the page :epkg:`builderapi`. The writer simplifies ... | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RSTTranslatorWithCustomDirectives ` | See :class:`HTMLWriterWithCustomDirectives`. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :class:`RSTWriterWithCustomDirectives ` | This :epkg:`docutils` writer extends the :epkg:`RST` writer with custom directives implemented in this module. | +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ Functions +++++++++ +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | function | truncated documentation | +=======================================================================================================================+==========================================================================================+ | :func:`_get_LaTeXTranslator ` | | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :func:`is_html5_writer_available ` | | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ | :func:`update_docutils_languages ` | Updates ``docutils/languages/en.py`` with missing labels. It Does it for languages *en*. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+ Properties ++++++++++ +---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ | property | truncated documentation | +===========================================================================================================================+=============================================================+ | :meth:`docname ` | Returns the docname of the document currently being parsed. | +---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ | :meth:`found_docs ` | contains all existing docnames. | +---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ | :meth:`math_renderer_name ` | | +---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ | :meth:`table ` | Get current table. | +---------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------+ Methods +++++++ +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +=========================================================================================================================================================+====================================================================================================================+ | :py:meth:`__init__ ` | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Construct the builder. Most of the parameter are static members of the class and cannot be overwritten (yet). ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Construct the builder. Most of the parameter are static members of the class and cannot be overwritten (yet). ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Construct the builder. Most of the parameter are static members of the class and cannot be overwritten (yet). ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | constructor | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | Same constructor as :epkg:`Sphinx application`. Additional parameters: | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_add_missing_ids ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_init_ ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_extended_init_ ` | Additional initialization steps. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_get_filename ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | Constructs the builder. Most of the parameter are static members of the class and cannot be overwritten ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init_builder ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_init_env ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_lookup_doctree ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_parallel ` | Not supported. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_write_serial ` | Overwrites *_write_serial* to avoid writing on disk. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_builder ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_config_value ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_configuration_options ` | Add new options. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_css_file ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_directive ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_directive_to_domain ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_domain ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_env_collector ` | See :epkg:`class Sphinx`. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_event ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_generic_role ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_js_file ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_latex_package ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_node ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_object_type ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_post_transform ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_role ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_role_to_domain ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_secnumber ` | Overwrites this method to catch errors due when it is a single document being processed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`add_transform ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`apply_post_transforms ` | Apply all post-transforms. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`assemble_doctree ` | Overwrites *assemble_doctree* to control the doctree. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`connect_directive_node ` | Adds custom node to the translator. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`create_builder ` | Creates a builder, raises an exception if name is None. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`create_translator ` | Returns an instance of translator. This method returns an instance of ``default_translator_class`` by default. ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`debug ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`disconnect_env_collector ` | Disables a collector given its class name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`finalize ` | Finalizes the documentation after it was parsed. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`fix_refuris ` | Overwrites *fix_refuris* to control the reference names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_doctree ` | Read the doctree for a file from the pickle and return it. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | Overwrites *get_target_uri* to control file names. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | Overwrites *get_target_uri* to control the page name. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | Override *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | Overrides *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | Overrides *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | Override *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | Override *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | Overrides *handle_page* to write into stream instead of files. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`info ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_doctree ` | Tells if the translator is doctree format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_html ` | Tells if the translator is :epkg:`html` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_latex ` | Tells if the translator is :epkg:`latex` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_md ` | Tells if the translator is :epkg:`markdown` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`is_rst ` | Tells if the translator is :epkg:`rst` format. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`iter_pages ` | Enumerate created pages. | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`setup_extension ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_pending_xref ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_viewcode_anchor ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`warning ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`write ` | Processes a document into its final form. Translates `document` (a Docutils document tree) into the Writer's ... | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :meth:`write_stylesheet ` | | +---------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.helpgen.sphinxm_convert_doc_sphinx_helper :members: :special-members: __init__ :show-inheritance: