.. _f-sphinxgithublinkextension:

module ``sphinxext.sphinx_githublink_extension``
================================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_githublink_extension


Short summary
+++++++++++++

module ``pyquickhelper.sphinxext.sphinx_githublink_extension``

Defines a :epkg:`sphinx` extension to display a link on github.


:githublink:`%|py|6`




Classes
+++++++

+------------------------------------------------------------------------------------------------+---------------------------+
| class                                                                                          | truncated documentation   |
+================================================================================================+===========================+
| :class:`githublink_node <pyquickhelper.sphinxext.sphinx_githublink_extension.githublink_node>` | defines *githublink* node |
+------------------------------------------------------------------------------------------------+---------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| function                                                                                      | truncated documentation                                                                                |
+===============================================================================================+========================================================================================================+
| :func:`githublink_role <pyquickhelper.sphinxext.sphinx_githublink_extension.githublink_role>` | Defines custom role *githublink*. The following instruction add a link to the documentation on github. |
+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :func:`make_link_node <pyquickhelper.sphinxext.sphinx_githublink_extension.make_link_node>`   | Create a link to a github file.                                                                        |
+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_githublink_extension.setup>`                     | setup for ``githublink`` (:epkg:`sphinx`)                                                              |
+-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+




Properties
++++++++++

+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+
| property                                                                                        | truncated documentation                                           |
+=================================================================================================+===================================================================+
| :meth:`document <pyquickhelper.sphinxext.sphinx_githublink_extension.githublink_node.document>` | Return the `document` root node of the tree containing this Node. |
+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+






Documentation
+++++++++++++

.. automodule:: pyquickhelper.sphinxext.sphinx_githublink_extension
    :members:
    :special-members: __init__
    :show-inheritance: