.. _f-notebooktesthelper: module ``automation.notebook_test_helper`` ========================================== Short summary +++++++++++++ module ``ensae_teaching_cs.automation.notebook_test_helper`` Some automation helpers to test notebooks and check they are still working fine. :githublink:`%|py|6` Functions +++++++++ +-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +===========================================================================================================+=====================================================================================================================================+ | :func:`a_test_notebook_runner ` | Runs and tests a specific list of notebooks. The function raises an exception if the execution fails. | +-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :func:`clean_function_1a ` | Function which cleans cells when unittesting notebooks 1A. | +-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :func:`copy_data_file ` | Copies a data file from a notebook folder to the current folder. | +-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :func:`execute_notebooks ` | Executes a list of notebooks. | +-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_additional_paths ` | Returns a list of paths to add before running the notebooks, paths to :epkg:`pyquickhelper`, :epkg:`pyensae`, :epkg:`pymmails`. ... | +-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :func:`ls_notebooks ` | Lists the notebooks in a particular subfolder. | +-----------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: ensae_teaching_cs.automation.notebook_test_helper :members: :special-members: __init__ :show-inheritance: