Adding Jupyter Notebooks

Jupyter Notebooks can be added using a Sphinx extension called nbsphinx. An .rst file for the notebook can be created to import the contents and also add any descriptive text like this.

Warning

Notebooks from the project directory / module directory could not be added using relative path. A solution has to be found.

The easiest solution was to place the notebooks were placed inside the docs/source/ directory. In the .rst file for the notebook, add the following to create a table of contents linking to the contents of the Jupyter notebook:

.. toctree::
   :caption: Contents
   :maxdepth: 1

   notebooks/demo

Contents

• A demo