Create an examples gallery with sphinx from Jupyter Notebooks


Keywords
sphinx sphinx-gallery examples documentation notebook ipython jupyter nbconvert nbsphinx
License
GPL-2.0
Install
pip install sphinx-nbexamples==0.1.2

Documentation

Create an examples gallery with sphinx from Jupyter Notebooks

docs Documentation Status
tests Travis Requirements Status Coverage
package PyPI Package latest release conda Latest github release
implementations Supported versions Supported implementations

Welcome! Similarly to Oscar Najeras sphinx-gallery module, this module intends to create an example gallery for your documentation. However, we don't use python scripts, instead we create the example gallery out of a bunch of jupyter notebooks using nbconvert.

This package can be used to

  1. Put all the examples you prepared in different notebooks in an pictured gallery
  2. use the same html (sphinx) scheme for your examples that you are using for your documentation
  3. Include the example notebooks in an offline (pdf) documentation
  4. Include not only the code, but also the link to required supplementary files
  5. Include a link to the Jupyter nbviewer

Installation

Simply install it via pip:

$ pip install sphinx-nbexamples

Or you install it via:

$ python setup.py install

from the source on GitHub.

Requirements

The package requires

  • Sphinx>=1.3: The python library for generating automated documentation
  • jupyter: The jupyter framework for jupyter notebooks. sphinx-nbexamples explicitly depends on