.. _f-sphinxrstbuilder: module ``sphinxext.sphinx_rst_builder`` ======================================= .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_rst_builder Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_rst_builder`` Defines a sphinx extension to output the documentation in :epkg:`RST`. It is inspired from `restbuilder `_. I replicate its license here: :: Copyright (c) 2012-2013 by Freek Dijkstra . Some rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. :githublink:`%|py|37` Classes +++++++ +-----------------------------------------------------------------------------------------+-----------------------------------+ | class | truncated documentation | +=========================================================================================+===================================+ | :class:`_BodyPlaceholder ` | | +-----------------------------------------------------------------------------------------+-----------------------------------+ | :class:`RstBuilder ` | Defines a :epkg:`RST` builder. | +-----------------------------------------------------------------------------------------+-----------------------------------+ | :class:`RstTranslator ` | Defines a :epkg:`RST` translator. | +-----------------------------------------------------------------------------------------+-----------------------------------+ | :class:`RstWriter ` | Defines a :epkg:`RST` writer. | +-----------------------------------------------------------------------------------------+-----------------------------------+ Functions +++++++++ +------------------------------------------------------------------+--------------------------------------+ | function | truncated documentation | +==================================================================+======================================+ | :func:`setup ` | Initializes the :epkg:`RST` builder. | +------------------------------------------------------------------+--------------------------------------+ Static Methods ++++++++++++++ +-----------------------------------------------------------------------------------------------------------------------+-------------------------+ | staticmethod | truncated documentation | +=======================================================================================================================+=========================+ | :py:meth:`_make_depart_admonition ` | | +-----------------------------------------------------------------------------------------------------------------------+-------------------------+ Methods +++++++ +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +================================================================================================================================+========================================================================================================================+ | :py:meth:`__init__ ` | Constructor, add a logger. | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`add_text ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`append ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_abbreviation ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_attribution ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_bigger_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_block_quote ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_bullet_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_caption ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_centered ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_citation ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_classifier ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_CodeNode ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_collapse_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_compact_paragraph ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_compound ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_definition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_definition_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_definition_list_item ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_addname ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_annotation ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_content ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_name ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_optional ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_parameterlist ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_returns ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_signature ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_desc_type ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_description ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_doctest_block ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_document ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_download_reference ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_downloadlink_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_emphasis ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_entry ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_enumerated_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field_body ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_field_name ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_figure ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_footnote ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_gdot_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_generated ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_gitlog_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_glossary ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_hlist ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_hlistcol ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_image ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_imgsgnode ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_inheritance_diagram ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_inline ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_issue ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_line ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_line_block ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_list_item ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_literal ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_literal_block ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_literal_emphasis ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_only ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_argument ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_group ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_list_item ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_option_string ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_paragraph ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_pending_xref ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_problematic ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_quote_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_refcount ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_reference ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_row ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_rubric ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_runpythonthis_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_section ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_seealso ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_sharenet_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_simpleimage ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_strong ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_subscript ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_subtitle ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_superscript ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_table ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_target ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_tbody ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_term ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_Text ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_tgroup ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_thead ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_title ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_title_reference ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_todo_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_topic ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_topic ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`depart_versionmodified ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`end_state ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`eval_expr ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`finish ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outdated_docs ` | Return an iterable of input files that are outdated. This method is taken from ``TextBuilder.get_outdated_docs()`` ... | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_outfilename ` | Overwrites *get_target_uri* to control file names. | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_target_uri ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`handle_page ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`init ` | Load necessary templates and perform initialization. | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`log_unknown ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`new_state ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`prepare_writing ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`translate ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_departure ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`unknown_visit ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_abbreviation ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_acks ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_admonition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_attribution ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_bigger_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_block_quote ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_bullet_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_caption ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_centered ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_citation ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_citation_reference ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_classifier ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_CodeNode ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_collapse_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_colspec ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_comment ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_compact_paragraph ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_compound ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_definition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_definition_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_definition_list_item ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_addname ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_annotation ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_content ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_name ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_optional ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_parameter ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_parameterlist ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_returns ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_signature ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_desc_type ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_description ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_doctest_block ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_document ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_download_reference ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_downloadlink_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_emphasis ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_entry ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_enumerated_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field_body ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_field_name ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_figure ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_footnote ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_footnote_reference ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_gdot_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_generated ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_gitlog_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_glossary ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_highlightlang ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_hlist ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_hlistcol ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_image ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_imgsgnode ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_index ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_inheritance_diagram ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_inline ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_issue ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_label ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_line ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_line_block ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_list_item ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_literal ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_literal_block ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_literal_emphasis ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_meta ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_only ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_argument ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_group ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_list ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_list_item ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_option_string ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_paragraph ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_pending_xref ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_problematic ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_productionlist ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_quote_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_raw ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_refcount ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_reference ` | Runs upon entering a reference. Because this class inherits from the TextTranslator class, regularly defined ... | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_row ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_rubric ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_runpythonthis_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_section ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_seealso ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_sharenet_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_simpleimage ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_strong ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_subscript ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_substitution_definition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_subtitle ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_superscript ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_system_message ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_table ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_tabular_col_spec ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_target ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_tbody ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_term ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_termsep ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_Text ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_tgroup ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_thead ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_title ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_title_reference ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_todo_node ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_topic ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_topic ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_transition ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`visit_versionmodified ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`wrap ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_doc ` | | +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_rst_builder :members: :special-members: __init__ :show-inheritance: