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.

Documentation (and example of use):

http://nbsphinx.rtfd.org/

Code:

http://github.com/spatialaudio/nbsphinx/

Python Package Index:

https://pypi.python.org/pypi/nbsphinx/

License:

MIT – see the file LICENSE for details.

Quick Start:

1. Install nbsphinx with pip:

   pip install nbsphinx --user
   

   ... or, if you prefer, just copy the file nbsphinx.py your Sphinx directory.

2. Edit your conf.py and add 'nbsphinx' to extensions.

3. Edit your index.rst and add the names of your *.ipynb files (without the .ipynb extension) to the toctree directive.

4. Run Sphinx!

All content shown below – except for the section A Normal reStructuredText File – was generated from Jupyter notebooks.

• Usage
  • HTML Themes
• An Example Notebook
  • Markdown
  • Code Cells
  • Special Display Formats
  • Raw Cells
• A Pre-Executed Notebook
  • Long-Running Cells
  • Rare Libraries
  • Exceptions
• Ignoring Errors
• Hidden Cells
• A Notebook in a Sub-Directory
• A Normal reStructuredText File
  • Links to Notebooks
  • Sphinx Directives for Jupyter Notebook Cells
• External Links

There is also An Orphan Notebook, just for the sake of it.