Custom Configuration¶
This project depends on sphinxcontrib-jupyter
to modify sphinx
to work with Jupyter notebooks.
Full documentation for the extension can be found here
An Example¶
Let’s say you have a collection of notebooks that you would like pre-executed.
You can do this by modifying the conf.py
file to enable notebook execution.
Add the following in the conf.py
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 by:
jupyter_dependency_lists = {
'lecture2' : ['lecture1']
'lecture3' : ['lecture1']
}
as documented here