DOC: add example of notebook [skip ci]

Medical-Image-Analysis-Laboratory · Jun 13, 2020 · 3ff3ec0 · 3ff3ec0
1 parent 1ef3114
commit 3ff3ec0
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/documentation/conf.py b/documentation/conf.py
@@ -45,7 +45,11 @@
               'sphinx.ext.autodoc',
               'sphinx.ext.mathjax',
               'sphinx.ext.viewcode',
-              'sphinxarg.ext']
+              'sphinxarg.ext',
+               'nbsphinx']
+
+# Allow errors in notebooks for doc
+nbsphinx_allow_errors = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/documentation/index.rst b/documentation/index.rst
@@ -97,10 +97,10 @@ Contents
 .. _user-usecases:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Examples & Tutorials
-
-
+   
+   NLM denoising <notebooks/brainHack.ipynb>
 
 .. _about-docs:
 

diff --git a/documentation/requirements.txt b/documentation/requirements.txt
@@ -1,4 +1,5 @@
 sphinx-argparse==0.2.5
+nbsphinx==0.7.0
 traits==4.6.0
 grabbit==0.2.3
 pybids==0.6.5