config-extension-execution.rst

Executing Notebooks

jupyter_execute_nb

Enables the execution of generated notebooks

Values
False (default)
True

.. todo::

    deprecate this option in favour of jupyter_execute_notebooks

jupyter_execute_notebooks

Enables the execution of generated notebooks

Values
False (default)
True

conf.py usage:

jupyter_execute_notebooks = True

jupyter_dependency_lists

Dependency of notebooks on other notebooks for execution can also be added to the configuration file above in the form of a dictionary. The key/value pairs will contain the names of the notebook files.

conf.py usage:

# add your dependency lists here
jupyter_dependency_lists = {
   'python_advanced_features' : ['python_essentials','python_oop'],
   'discrete_dp' : ['dp_essentials'],
}

jupyter_dependencies

Specify support (dependencies) for notebook collection at the file or the directory level.

conf.py usage:

jupyter_dependencies = {
    <dir> : ['file1', 'file2'],
    {<dir>}/<file.rst> : ['file1']
}

Note

to specify a support file at the root level of the source directory the key should be ""

jupyter_number_workers

Specify the number cores to use with dask

Values
Integer (default = 1)

conf.py usage:

jupyter_number_workers = 4

jupyter_threads_per_worker

Specify the number of threads per worker for dask

Values
Integer (default = 1)

conf.py usage:

jupyter_threads_per_worker = 1