.. _f-ftppublishhelper: module ``automation.ftp_publish_helper`` ======================================== Short summary +++++++++++++ module ``ensae_teaching_cs.automation.ftp_publish_helper`` Helpers to publish the documentation of :epkg:`python` to a website. :githublink:`%|py|6` Functions +++++++++ +-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +===================================================================================================================+==================================================================================================================================================================================================================================================+ | :func:`content_as_binary ` | Overloads function `content_as_finary `_ ... | +-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`publish_documentation ` | Publishes the documentation and the setups of a python module on a webiste, it assumes the modules is organized the ... | +-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`publish_teachings_to_web ` | Copies the documentation to the website. | +-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`text_transform ` | If filename is *rss.xml*, replaces the string *__BLOG_ROOT__* by *self._root_web*. | +-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`trigger_on_specific_strings ` | Looks for specific string such as *USERNAME*, *USERDNSDOMAIN*, *HOMEPATH*, *USERNAME*, *COMPUTERNAME*, *LOGONSERVER*, ... | +-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: ensae_teaching_cs.automation.ftp_publish_helper :members: :special-members: __init__ :show-inheritance: