Custom Configuration through sphinxcontrib-jupyter

This project depends on sphinxcontrib-jupyter to enhance sphinx to build and work with Jupyter notebooks.

Full documentation for the extension can be found here

There are many configuration settings that can adjust the compilation behaviour of your project.

An Example

Let’s say you have a collection of notebooks that you would like pre-executed. You can do this by modifying the file to enable notebook execution.

Add the following in the in the jupyter options section:

jupyter_execute_notebooks = True

as documented here

and let’s imagine some of your documents produce a file required by a future document in your collection. An execution dependency can be added to your project by specifying:

jupyter_dependency_lists = {
    'lecture2' : ['lecture1']
    'lecture3' : ['lecture1']

in the file as documented here