Skip to content
Create an examples gallery with sphinx from Jupyter Notebooks
Python Jupyter Notebook CSS
Branch: master
Clone or download
Latest commit f71e45d Jul 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Minor May 17, 2019
examples ENH: Add Bash example to gallery May 14, 2019
sphinx_nbexamples fix typo in docstring Jul 13, 2019
tests
.gitignore Don't synchronize docs/examples Oct 25, 2016
.travis.yml added test for example_bash May 14, 2019
CHANGELOG.rst increased version to 0.4.0 May 18, 2019
LICENSE New version including LICENSE Feb 28, 2017
MANIFEST.in New version including LICENSE Feb 28, 2017
README.rst be more explicit about dependencies May 17, 2019
postBuild Added binder configuration files May 16, 2019
readthedocs.yml do not use conda on RTD Nov 27, 2018
requirements.txt removed sphinx-nbexample specific requirements May 16, 2019
setup.cfg Minor changes [skip ci] Jul 19, 2017
setup.py increased version to 0.4.0 May 18, 2019

README.rst

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
You can’t perform that action at this time.