.. _f-sphinxdownloadlinkextension: module ``sphinxext.sphinx_downloadlink_extension`` ================================================== .. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_downloadlink_extension Short summary +++++++++++++ module ``pyquickhelper.sphinxext.sphinx_downloadlink_extension`` Defines a :epkg:`sphinx` extension to show a link instead of downloading it. This extension does not work for :epkg:`Sphinx` < 1.8. :githublink:`%|py|7` Classes +++++++ +----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | class | truncated documentation | +======================================================================================================================+====================================================+ | :class:`downloadlink_node ` | Defines *download_reference* node. | +----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ | :class:`DownloadLinkFileCollector ` | Download files collector for *sphinx.environment*. | +----------------------------------------------------------------------------------------------------------------------+----------------------------------------------------+ Functions +++++++++ +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +===============================================================================================================================+==========================================================================================================================+ | :func:`copy_download_files ` | Copies all files mentioned with role *downloadlink*. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_downloadlink_node_html ` | Converts node *downloadlink* into :epkg:`html`. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_downloadlink_node_latex ` | Does notthing. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_downloadlink_node_md ` | Converts node *downloadlink* into :epkg:`md`. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_downloadlink_node_rst ` | Converts node *downloadlink* into :epkg:`rst`. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`depart_downloadlink_node_text ` | Does notthing. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`process_downloadlink_role ` | Defines custom role *downloadlink*. The following instructions defines a link which can be displayed or hidden based ... | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`setup ` | setup for ``bigger`` (sphinx) | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_downloadlink_node_html ` | Converts node *downloadlink* into :epkg:`html`. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_downloadlink_node_latex ` | Does notthing. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_downloadlink_node_md ` | Converts node *downloadlink* into :epkg:`md`. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_downloadlink_node_rst ` | Converts node *downloadlink* into :epkg:`rst`. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | :func:`visit_downloadlink_node_text ` | Does notthing. | +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Properties ++++++++++ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ | property | truncated documentation | +=====================================================================================================+===================================================================+ | :meth:`document ` | Return the `document` root node of the tree containing this Node. | +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ Methods +++++++ +-------------------------------------------------------------------------------------------------------------------+----------------------------------+ | method | truncated documentation | +===================================================================================================================+==================================+ | :meth:`check_attr ` | | +-------------------------------------------------------------------------------------------------------------------+----------------------------------+ | :meth:`clear_doc ` | | +-------------------------------------------------------------------------------------------------------------------+----------------------------------+ | :meth:`merge_other ` | | +-------------------------------------------------------------------------------------------------------------------+----------------------------------+ | :meth:`process_doc ` | Process downloadable file paths. | +-------------------------------------------------------------------------------------------------------------------+----------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.sphinxext.sphinx_downloadlink_extension :members: :special-members: __init__ :show-inheritance: