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):
- Code:
- Python Package Index:
- License:
MIT -- see the file
LICENSE
for details.- Quick Start:
Install
nbsphinx
with pip:pip install nbsphinx --user
- Edit your
conf.py
and add'nbsphinx'
toextensions
. - Edit your
index.rst
and add the names of your*.ipynb
files (without the.ipynb
extension) to thetoctree
directive. - Run Sphinx!