From 3ff3ec0d6be2962226537c76d74a39736c24be94 Mon Sep 17 00:00:00 2001 From: Sebastien Tourbier Date: Sat, 13 Jun 2020 19:09:16 +0200 Subject: [PATCH] DOC: add example of notebook [skip ci] --- documentation/conf.py | 6 +++++- documentation/index.rst | 6 +++--- documentation/requirements.txt | 1 + 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/documentation/conf.py b/documentation/conf.py index 2b8855d60..6ecf12f00 100644 --- 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 index 12b31f74a..da5285bd5 100644 --- 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 .. _about-docs: diff --git a/documentation/requirements.txt b/documentation/requirements.txt index 4bcd9b145..9d388b933 100644 --- 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