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.py
and add'nbsphinx'
toextensions
.Edit your
index.rst
and add the names of your*.ipynb
files to thetoctree
.Run Sphinx!
- Online documentation (and example of use):
- Source code repository (and issue tracker):
- License:
MIT – see the file
LICENSE
for details.
All content shown below – except for the sections Normal reStructuredText Files, Contributing and Version History – was generated from Jupyter notebooks.
- Installation
- Usage
- Sphinx Setup
- Sphinx Configuration Values
nbsphinx
Configuration Valuesnbsphinx_allow_errors
nbsphinx_codecell_lexer
nbsphinx_custom_formats
nbsphinx_epilog
nbsphinx_execute
nbsphinx_execute_arguments
nbsphinx_input_prompt
nbsphinx_kernel_name
nbsphinx_output_prompt
nbsphinx_prolog
nbsphinx_prompt_width
nbsphinx_requirejs_options
nbsphinx_requirejs_path
nbsphinx_responsive_width
nbsphinx_thumbnails
nbsphinx_timeout
nbsphinx_widgets_options
nbsphinx_widgets_path
- Running Sphinx
- Watching for Changes with
sphinx-autobuild
- Automatic Creation of HTML and PDF output on readthedocs.org
- HTML Themes
- Using Notebooks with Git
- Sphinx Setup
- Markdown Cells
- Code Cells
- Raw Cells
- Hidden Cells
- Controlling Notebook Execution
- Prolog and Epilog
- Custom Notebook Formats
- Notebooks in Sub-Directories
- Creating Thumbnail Galleries
- Using
toctree
In A Notebook - Normal reStructuredText Files
- External Links
- Contributing
- Version History
There is also An Orphan Notebook (HTML Only), just for the sake of it.