enh: enable rendering of the jupyter notebooks

nipreps · Nov 30, 2023 · 53f1c72 · 53f1c72
1 parent b75f288
commit 53f1c72
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -36,6 +36,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinxcontrib.apidoc",
+    "nbsphinx",
     "nipype.sphinxext.apidoc",
     "nipype.sphinxext.plot_workflow",
 ]

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,8 @@
+Examples
+========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   notebooks/SDC - Theory and physics
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,6 +7,7 @@ Contents
     :maxdepth: 3
 
     installation
+    examples
     methods
     api
     changes
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,15 +1,20 @@
 attrs >= 20.1.0
 furo
 importlib_resources
+ipykernel
+ipython
 matplotlib >= 2.2.0
+nbsphinx
 nibabel
 nipype >= 1.5.1
-traits < 6.4
 niworkflows ~= 1.6.3
 numpy
 packaging
+pandoc
 pydot >= 1.2.3
 pydotplus
+scipy
 sphinx >= 7.2.2
 sphinxcontrib-apidoc
 templateflow
+traits < 6.4