nbsphinx
  • Usage
    • Installation
    • Sphinx Setup
    • Running Sphinx
    • Watching for Changes with sphinx-autobuild
    • Automatic Creation of HTML and PDF output on readthedocs.org
    • HTML Themes
  • Markdown Cells
    • Equations
    • Code
    • Tables
    • Images
    • HTML Elements (HTML only)
    • Info/Warning Boxes
    • Links to Other Notebooks
    • Links to *.rst Files (and Other Sphinx Source Files)
    • Links to Local Files (HTML only)
  • Code Cells
    • Code, Output, Streams
    • Cell Magics
    • Special Display Formats
    • ANSI Colors
  • Raw Cells
    • Usage
    • Available Raw Cell Formats
  • Hidden Cells
  • Controlling Notebook Execution
    • Pre-Executing Notebooks
    • Explicitly Dis-/Enabling Notebook Execution
    • Ignoring Errors
    • Cell Execution Timeout
  • Notebooks in Sub-Directories
    • A Sub-Section
  • Using toctree In A Notebook
    • A Notebook that’s just a “toctree” Target
    • An External Link (HTML only)
  • Normal reStructuredText Files
    • Links to Notebooks
    • Sphinx Directives for Info/Warning Boxes
  • External Links
 
nbsphinx
  • Docs »
  • External Links
  • Edit on GitHub

External LinksΒΆ

notebook_sphinxext.py

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

No LaTeX support.

https://github.com/ngoldbaum/RunNotebook

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

https://github.com/ipython/nbconvert/pull/35

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

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

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

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

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

Previous

© Copyright 2016, Matthias Geier.

Built with Sphinx using a theme provided by Read the Docs.