.. _f-utilssphinxdochelpers: module ``helpgen.utils_sphinx_doc_helpers`` =========================================== .. inheritance-diagram:: pyquickhelper.helpgen.utils_sphinx_doc_helpers Short summary +++++++++++++ module ``pyquickhelper.helpgen.utils_sphinx_doc_helpers`` Various variables and classes used to produce a Sphinx documentation. :githublink:`%|py|5` Classes +++++++ +---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ | class | truncated documentation | +=============================================================================================+=======================================================================+ | :class:`IndexInformation ` | Keeps some information to index. | +---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :class:`ModuleMemberDoc ` | Represents a member in a module. See :epkg:`*py:inspect`. Attributes: | +---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ | :class:`RstFileHelp ` | Defines what a rst file and what it describes. | +---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ Functions +++++++++ +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | function | truncated documentation | +==========================================================================================================================+=================================================================================+ | :func:`compute_truncated_documentation ` | Produces a truncated version of a docstring. | +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | :func:`example_function_latex ` | This function only contains an example with latex to check it is working fine. | +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | :func:`fix_image_page_for_root ` | Looks for images and fix their path as if the extract were copied to the root. | +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | :func:`get_module_objects ` | Gets all the classes from a module. | +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | :func:`import_module ` | Imports a module using its filename. | +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | :func:`make_label_index ` | Builds a :epkg:`sphinx` label from a string by removing any odd characters. | +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | :func:`process_look_for_tag ` | Looks for specific information in all files, collect them into one single page. | +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | :func:`process_var_tag ` | Processes a docstring using tag ``@ var``, and return a list of 2-tuple | +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | :func:`remove_some_indent ` | Brings text to the left. | +--------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ Properties ++++++++++ +----------------------------------------------------------------------------------------------+---------------------------------------------------+ | property | truncated documentation | +==============================================================================================+===================================================+ | :meth:`classname ` | Returns the class name if the object is a method. | +----------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`key ` | Returns a key to identify it. | +----------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`truncdoc ` | Returns ``self.text``. | +----------------------------------------------------------------------------------------------+---------------------------------------------------+ Static Methods ++++++++++++++ +-----------------------------------------------------------------------------------------------+----------------------------------------------+ | staticmethod | truncated documentation | +===============================================================================================+==============================================+ | :meth:`get_label ` | Returns a new label given the existing ones. | +-----------------------------------------------------------------------------------------------+----------------------------------------------+ Methods +++++++ +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | method | truncated documentation | +=============================================================================================================================+===============================================================================+ | :py:meth:`__cmp__ ` | Comparison operators, compares first the first, second the name (lower case). | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :py:meth:`__eq__ ` | Operator ``==``. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :py:meth:`__gt__ ` | Operator ``>``. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :py:meth:`__lt__ ` | Operator ``<``. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | usual | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | usual | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :meth:`add_label_if_not_present ` | The function checks the label is present in the original file. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :meth:`add_prefix ` | Adds a prefix (for the documentation). | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :meth:`populate ` | Extracts some information about an object. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :meth:`rst_link ` | return a link rst | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :meth:`rst_link ` | Returns a sphinx link on the object. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | :meth:`set_rst_file ` | Sets the rst file and checks the label is present in it. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.helpgen.utils_sphinx_doc_helpers :members: :special-members: __init__ :show-inheritance: