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.
- Quick Start:
- Edit your
- Edit your
index.rstand add the names of your
*.ipynbfiles to the
- Run Sphinx!
- Online documentation (and example of use):
- Source code repository (and issue tracker):
- MIT – see the file
All content shown below – except for the section Normal reStructuredText Files – was generated from Jupyter notebooks.
- Markdown Cells
- Cell Attachments
- HTML Elements (HTML only)
- Info/Warning Boxes
- Links to Other Notebooks
- Links to
*.rstFiles (and Other Sphinx Source Files)
- Links to Local Files
- Links to Domain Objects
- Code Cells
- Raw Cells
- Hidden Cells
- Controlling Notebook Execution
- Prolog and Epilog
- Custom Notebook Formats
- Notebooks in Sub-Directories
toctreeIn A Notebook
- Normal reStructuredText Files
- External Links
There is also An Orphan Notebook (HTML Only), just for the sake of it.