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.readthedocs.io/
- Source code repository (and issue tracker):
- https://github.com/spatialaudio/nbsphinx/
- Python Package Index:
- https://pypi.python.org/pypi/nbsphinx/
- License:
- MIT – see the file
LICENSE
for details. - Quick Start:
Install
nbsphinx
:python3 -m pip install nbsphinx --user
Edit your
conf.py
and add'nbsphinx'
toextensions
.Edit your
index.rst
and add the names of your*.ipynb
files to thetoctree
.Run Sphinx!
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.