Skip to content


Repository files navigation

Jupyter Notebook Tools for Sphinx

nbsphinx is a Sphinx extension that provides a source parser for *.ipynb files. Custom Sphinx directives are used to show Jupyter Notebook code cells (and of course their results) in both HTML and LaTeX output. Un-evaluated notebooks -- i.e. notebooks without stored output cells -- will be automatically executed during the Sphinx build process.

Quick Start:
  1. Install nbsphinx
  2. Edit your and add 'nbsphinx' to extensions.
  3. Edit your index.rst and add the names of your *.ipynb files to the toctree.
  4. Run Sphinx!
Online documentation (and example of use):
Source code repository (and issue tracker):
MIT -- see the file LICENSE for details.