.. _f-images: module ``sphinxext.sphinximages.sphinxtrib.images`` =================================================== .. inheritance-diagram:: pyquickhelper.sphinxext.sphinximages.sphinxtrib.images Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinximages.sphinxtrib.images`` :epkg:`Sphinx` extension for images. :githublink:`%|py|6` Classes +++++++ +-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +=================================================================================================+================================================================================================================+ | :class:`gallery_node ` | :epkg:`sphinx` node | +-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :class:`image_node ` | :epkg:`sphinx` node | +-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | :class:`ImageDirective ` | Directive which overrides default sphinx directive. It's backward compatibile and it's adding more cool stuff. | +-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ Functions +++++++++ +----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | function | truncated documentation | +============================================================================================================================+====================================================+ | :func:`configure_backend ` | local function | +----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | :func:`directive_boolean ` | local function | +----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | :func:`download_images ` | Downloads images before running the documentation. | +----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | :func:`get_image_extension ` | Guesses an extension for an image. | +----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | :func:`install_backend_static_files ` | local function | +----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | :func:`setup ` | setup for :epkg:`sphinx` extension | +----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ Properties ++++++++++ +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ | property | truncated documentation | +=================================================================================================+===================================================================+ | :meth:`document ` | Return the `document` root node of the tree containing this Node. | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ | :meth:`document ` | Return the `document` root node of the tree containing this Node. | +-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ Methods +++++++ +-----------------------------------------------------------------------------------------------------+-------------------------+ | method | truncated documentation | +=====================================================================================================+=========================+ | :meth:`align ` | | +-----------------------------------------------------------------------------------------------------+-------------------------+ | :meth:`is_remote ` | local function | +-----------------------------------------------------------------------------------------------------+-------------------------+ | :meth:`run ` | | +-----------------------------------------------------------------------------------------------------+-------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinximages.sphinxtrib.images :members: :special-members: __init__ :show-inheritance: