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:
- Install
nbsphinx - Edit your
conf.pyand add'nbsphinx'toextensions. - Edit your
index.rstand add the names of your*.ipynbfiles to thetoctree. - Run Sphinx!
- Install
- Online documentation (and example of use):
- http://nbsphinx.readthedocs.io/
- Source code repository (and issue tracker):
- https://github.com/spatialaudio/nbsphinx/
- License:
- MIT – see the file
LICENSEfor details.
All content shown below – except for the section Normal reStructuredText Files – was generated from Jupyter notebooks.
There is also An Orphan Notebook (HTML Only), just for the sake of it.