.. _f-utilssphinxdoc: module ``helpgen.utils_sphinx_doc`` =================================== .. inheritance-diagram:: pyquickhelper.helpgen.utils_sphinx_doc Short summary +++++++++++++ module ``pyquickhelper.helpgen.utils_sphinx_doc`` various helpers to produce a Sphinx documentation :githublink:`%|py|6` Classes +++++++ +-----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ | class | truncated documentation | +===================================================================================================================================+===================================================================================+ | :class:`useless_class_UnicodeStringIOThreadSafe ` | avoid conversion problem between str and char, class protected again Thread issue | +-----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ Functions +++++++++ +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +==================================================================================================================================+=============================================================================================================================+ | :func:`_private_migrating_doxygen_doc ` | | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`_private_process_one_file ` | Copies one file from the source to the documentation folder. It processes some comments in doxygen format (@ param, ... | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`add_file_rst ` | Creates a :epkg:`rst` file for every source file. | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`apply_modification_template ` | See :func:`add_file_rst`. | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`copy_source_files ` | Copies all sources files (input) into a folder (output), apply on each of them a modification. | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`doc_checking ` | Example of a doc string. | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`filecontent_to_rst ` | Produces a *.rst* file which contains the file. It adds a title and a label based on the filename (no folder included). ... | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`fix_incomplete_references ` | Looks into every file .rst or .py for incomplete reference. Example | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`migrating_doxygen_doc ` | Migrates the doxygen documentation to rst format. | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`prepare_file_for_sphinx_help_generation ` | Prepares all files for :epkg:`Sphinx` generation. | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`process_copy_images ` | Looks into every file .rst or .py for images ( | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`produces_indexes ` | Produces a file for each category of object found in the module. | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`remove_undesired_part_for_documentation ` | Some files contains blocs inserted between the two lines: | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`replace_relative_import_fct ` | Takes a :epkg:`python` file and replaces all relative imports it was able to find by an import which can be processed ... | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :func:`validate_file_for_help ` | Accepts or rejects a file to be copied in the help folder. | +----------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Methods +++++++ +---------------------------------------------------------------------------------------------------------------+-------------------------+ | method | truncated documentation | +===============================================================================================================+=========================+ | :py:meth:`__init__ ` | creates a lock | +---------------------------------------------------------------------------------------------------------------+-------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.helpgen.utils_sphinx_doc :members: :special-members: __init__ :show-inheritance: