.. _f-notebooktesthelper:

module ``automation.notebook_test_helper``
==========================================







Short summary
+++++++++++++

module ``code_beatrix.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:`clean_function_notebook <code_beatrix.automation.notebook_test_helper.clean_function_notebook>` | Cleans cells when unittesting notebooks.                                                         |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :func:`execute_notebooks <code_beatrix.automation.notebook_test_helper.execute_notebooks>`             | Executes a list of notebooks.                                                                    |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :func:`get_additional_paths <code_beatrix.automation.notebook_test_helper.get_additional_paths>`       | Returns a list of paths to add before running the notebooks, paths to :epkg:`pyquickhelper`, ... |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :func:`ls_notebooks <code_beatrix.automation.notebook_test_helper.ls_notebooks>`                       | Returns the list of notebooks in a particular subfolder.                                         |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: code_beatrix.automation.notebook_test_helper
    :members:
    :special-members: __init__
    :show-inheritance: