added example notebook

leifwalsh · Aug 27, 2017 · 5e28072 · 5e28072
1 parent 3835aa2
commit 5e28072
Show file tree

Hide file tree

Showing 4 changed files with 1,421 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,6 +45,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
+    'nbsphinx',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode'
 ]

diff --git a/docs/example.ipynb b/docs/example.ipynb
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,6 +9,7 @@ Contents:
    readme
    installation
    usage
+   example.ipynb
    api
    contributing
    authors

diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -7,6 +7,7 @@ tox==2.3.1
 coverage==4.1
 Sphinx>=1.6,<1.7
 sphinx-rtd-theme>=0.2,<0.3
+nbsphinx>=0.2,<0.3
 cryptography==1.7
 PyYAML==3.11