/nbsphinx

Sphinx source parser for *.ipynb files

Primary LanguagePythonMIT LicenseMIT

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:
https://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:

    pip install nbsphinx --user

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

  3. Edit your index.rst and add the names of your *.ipynb files to the toctree.

  4. Run Sphinx!