Jupyter Notebook Tools for Sphinx¶
nbsphinx is a Sphinx extension that provides a source parser for
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):
- Python Package Index:
- MIT – see the file
- Quick Start:
pip install nbsphinx --user
... or, if you prefer, just copy the file
nbsphinx.pyyour Sphinx directory.
index.rstand add the names of your
*.ipynbfiles (without the
.ipynbextension) to the
All content shown below – except for the section A Normal reStructuredText File – was generated from Jupyter notebooks.
- An Example Notebook
- A Pre-Executed Notebook
- Ignoring Errors
- Hidden Cells
- A Notebook in a Sub-Directory
- A Normal reStructuredText File
- External Links
There is also An Orphan Notebook, just for the sake of it.