This notebook is part of the nbsphinx documentation: https://nbsphinx.readthedocs.io/.

External Links

nbconvert

The official conversion tool of the Jupyter project. It can be used to convert notebooks to HTML, LaTeX and many other formats.

Its --execute flag can be used to automatically execute notebooks before conversion.

https://nbconvert.readthedocs.io/

https://github.com/jupyter/nbconvert

RunNotebook (notebook_sphinxext.py)

Notebooks can be included in *.rst files with a custom notebook directive. Uses nbconvert to execute notebooks and to convert the result to HTML.

No LaTeX support.

https://github.com/ngoldbaum/RunNotebook

There are some forks:

• https://bitbucket.org/yt_analysis/yt-doc/src/default/extensions/notebook_sphinxext.py
• https://github.com/matthew-brett/perrin-academy/blob/master/sphinxext/notebook_sphinxext.py

nbsite

Build a tested, sphinx-based website from notebooks.

https://nbsite.pyviz.org/

ipypublish

A workflow for creating and editing publication ready scientific reports and presentations, from one or more Jupyter Notebooks, without leaving the browser!

https://ipypublish.readthedocs.io/

https://github.com/chrisjsewell/ipypublish

jupyterbook

Jupyter Book is an open source project for building beautiful, publication-quality books and documents from computational material.

https://jupyterbook.org/

https://github.com/executablebooks/jupyter-book

Previous tagline: "Create an online book with Jupyter Notebooks and Jekyll": https://legacy.jupyterbook.org/

MyST-NB

A collection of tools for working with Jupyter Notebooks in Sphinx.

The primary tool this package provides is a Sphinx parser for ipynb files. This allows you to directly convert Jupyter Notebooks into Sphinx documents. It relies heavily on the MyST parser.

https://myst-nb.readthedocs.io/

https://github.com/ExecutableBookProject/MyST-NB

nbinteract

Create interactive webpages from Jupyter Notebooks

https://www.nbinteract.com/

https://github.com/SamLau95/nbinteract

nb_pdf_template

An extended nbconvert template for LaTeX output.

https://github.com/t-makaro/nb_pdf_template

nb2plots

Notebook to reStructuredText converter which uses a modified version of the matplotlib plot directive.

https://github.com/matthew-brett/nb2plots

brole

A Sphinx role for IPython notebooks

https://github.com/matthew-brett/brole

Sphinx-Gallery

https://sphinx-gallery.readthedocs.io/

sphinx-nbexamples

https://sphinx-nbexamples.readthedocs.io/

https://github.com/Chilipp/sphinx-nbexamples

nbsphinx-link

https://github.com/vidartf/nbsphinx-link

Uses nbsphinx, but supports notebooks outside the Sphinx source directory.

See https://github.com/spatialaudio/nbsphinx/pull/33 for some limitations.

bookbook

Uses nbconvert to create a sequence of HTML or a concatenated LaTeX file from a sequence of notebooks.

https://github.com/takluyver/bookbook

jupyter-sphinx

Jupyter Sphinx is a Sphinx extension that executes embedded code in a Jupyter kernel, and embeds outputs of that code in the output document. It has support for rich output such as images, Latex math and even javascript widgets.

https://jupyter-sphinx.readthedocs.io/

https://github.com/jupyter/jupyter-sphinx

DocOnce

http://hplgit.github.io/doconce/doc/web/index.html

Converting Notebooks to reStructuredText

https://github.com/perrette/dimarray/blob/master/docs/scripts/nbconvert_to_rst.py

https://gist.github.com/hadim/16e29b5848672e2e497c (not available anymore)

https://sphinx-ipynb.readthedocs.io/

Converting reStructuredText to Notebooks

https://github.com/nthiery/rst-to-ipynb

https://github.com/QuantEcon/sphinxcontrib-jupyter

Converting Notebooks to HTML for Blog Posts

http://dongweiming.github.io/divingintoipynb_nikola/posts/nbconvert.html

https://github.com/getpelican/pelican-plugins/blob/master/liquid_tags/notebook.py

Further Posts and Issues

https://github.com/ipython/ipython/issues/4936

https://mail.scipy.org/pipermail/ipython-user/2013-December/013490.html (not available anymore)