.. _f-sphinxgdotextension: module ``sphinxext.sphinx_gdot_extension`` ========================================== .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_gdot_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_gdot_extension`` Defines a sphinx extension to show :epkg:`DOT` graph with :epkg:`viz.js` or :epkg:`graphviz`. :githublink:`%|py|7` Classes +++++++ +--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +======================================================================================+======================================================================================================================+ | :class:`gdot_node ` | defines ``gdot`` node. | +--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :class:`GDotDirective ` | A ``gdot`` node displays a :epkg:`DOT` graph. The build choose :epkg:`SVG` for :epkg:`HTML` format and image for ... | +--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+ Functions +++++++++ +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +=============================================================================================================+==================================================================================================================================================+ | :func:`copy_js_files ` | | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_gdot_node_html ` | depart collapse_node | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_gdot_node_html_svg ` | depart collapse_node | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_gdot_node_rst ` | depart collapse_node | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`setup ` | setup for ``gdot`` (sphinx) | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_gdot_node_html ` | visit collapse_node, the function switches between `graphviz.py `_ ... | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_gdot_node_html_svg ` | visit collapse_node | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_gdot_node_rst ` | visit collapse_node | +-------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Properties ++++++++++ +-------------------------------------------------------------------------------------+-------------------------------------------------------------------+ | property | truncated documentation | +=====================================================================================+===================================================================+ | :meth:`document ` | Return the `document` root node of the tree containing this Node. | +-------------------------------------------------------------------------------------+-------------------------------------------------------------------+ Methods +++++++ +-------------------------------------------------------------------------------+---------------------------+ | method | truncated documentation | +===============================================================================+===========================+ | :meth:`run ` | Builds the collapse text. | +-------------------------------------------------------------------------------+---------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_gdot_extension :members: :special-members: __init__ :show-inheritance: