.. _f-sphinxmmockapp: module ``helpgen.sphinxm_mock_app`` =================================== .. inheritance-diagram:: pyquickhelper.helpgen.sphinxm_mock_app Short summary +++++++++++++ module ``pyquickhelper.helpgen.sphinxm_mock_app`` Helpers to convert docstring to various format. :githublink:`%|py|5` Classes +++++++ +-------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | class | truncated documentation | +===============================================================================+=========================================================================+ | :class:`MockSphinxApp ` | Mocks :epkg:`Sphinx` application. In memory :epkg:`Sphinx` application. | +-------------------------------------------------------------------------------+-------------------------------------------------------------------------+ Properties ++++++++++ +--------------------------------------------------------------------------------------+-------------------------+ | property | truncated documentation | +======================================================================================+=========================+ | :meth:`extensions ` | | +--------------------------------------------------------------------------------------+-------------------------+ Static Methods ++++++++++++++ +------------------------------------------------------------------------------+------------------------------------------------------+ | staticmethod | truncated documentation | +==============================================================================+======================================================+ | :meth:`create ` | Creates a :class:`MockSphinxApp` for :epkg:`Sphinx`. | +------------------------------------------------------------------------------+------------------------------------------------------+ Methods +++++++ +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | method | truncated documentation | +==================================================================================================================+===================================================+ | :py:meth:`__init__ ` | | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_autodocumenter ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_builder ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_config_value ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_css_file ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_directive ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_domain ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_env_collector ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_event ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_js_file ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_mapping ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_node ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_role ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`add_source_parser ` | Registers a parser for a specific file extension. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`connect ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`disconnect_env_collector ` | Disconnects a collector given its class name. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`emit ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`emit_firstresult ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`finalize ` | Finalizes the documentation after it was parsed. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`get_default_values ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`require_sphinx ` | | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ | :meth:`setup_extension ` | See :epkg:`class Sphinx`. | +------------------------------------------------------------------------------------------------------------------+---------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.helpgen.sphinxm_mock_app :members: :special-members: __init__ :show-inheritance: