.. _f-processnotebooks: module ``helpgen.process_notebooks`` ==================================== Short summary +++++++++++++ module ``pyquickhelper.helpgen.process_notebooks`` Contains the main function to generate the documentation for a module designed the same way as this one, :func:`generate_help_sphinx`. :githublink:`%|py|8` Functions +++++++++ +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +=======================================================================================================================+==============================================================================================================================+ | :func:`_preprocess_notebook ` | Preprocesses the content of a notebook. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`_process_notebooks_in ` | The notebook conversion does not handle images from url for :epkg:`pdf` and :epkg:`docx`. They could be downloaded first ... | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`_process_notebooks_in_private ` | This function fails in nbconvert 6.0 when the conversion is called more than once. The conversion probably changes the ... | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`_process_notebooks_in_private_cmd ` | | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`add_link_to_notebook ` | Adds a link to the notebook in :epkg:`HTML` format and does a little bit of cleaning for various format. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`add_tag_for_slideshow ` | Modifies a notebook to add tag for a slideshow. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`build_all_notebooks_coverage ` | Creates a :epkg:`rst` page (gallery) with links to all notebooks and information about coverage. It relies on function ... | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`build_notebooks_gallery ` | Creates a :epkg:`rst` page (gallery) with links to all notebooks. For each notebook, it creates a snippet. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`build_thumbail_in_gallery ` | Returns :epkg:`rst` code for a notebook. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`find_pdflatex ` | Returns the executable for latex. | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :func:`process_notebooks ` | Converts notebooks into :epkg:`html`, :epkg:`rst`, :epkg:`latex`, :epkg:`pdf`, :epkg:`python`, :epkg:`docx` using ... | +-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.helpgen.process_notebooks :members: :special-members: __init__ :show-inheritance: