Skip to main content

Create an examples gallery with sphinx from Jupyter Notebooks

Project description

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 only requires Sphinx, ipython and nbconvert to be installed. It has been tested for versions higher than 1.3.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-nbexamples-0.3.2.tar.gz (29.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page