Merge pull request #409 from nipreps/docs/render-notebooks

ENH: Enable rendering of the Jupyter notebooks

.github/workflows/docs-build-pr.yml

@@ -39,10 +39,15 @@ jobs:
         echo "Building branch/tag ${CURBRANCH:-<unkwown>}, from git ref <$GITHUB_REF>"
         echo "CURBRANCH=${CURBRANCH}" >> ${GITHUB_ENV}
 
-    - name: Install GraphViz
+    - name: Set up Python 3
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3
+
+    - name: Install GraphViz & pandoc
       run: |
         sudo apt-get update -y
-        sudo apt-get install -y --no-install-recommends graphviz
+        sudo apt-get install -y --no-install-recommends graphviz pandoc
 
     - name: Install dependencies
       run: |

.github/workflows/docs-build-update.yml

@@ -39,10 +39,15 @@ jobs:
         # Pacify git if we were to commit something
         git config user.email "[email protected]"
         git config user.name "NiPreps Bot"
-    - name: Install GraphViz
+    - name: Install GraphViz & pandoc
       run: |
         sudo apt-get update -y
-        sudo apt-get install -y --no-install-recommends graphviz
+        sudo apt-get install -y --no-install-recommends graphviz pandoc
+
+    - name: Set up Python 3
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3
 
     - name: Install dependencies
       run: |

docs/conf.py

@@ -36,6 +36,7 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinxcontrib.apidoc",
+    "nbsphinx",
     "nipype.sphinxext.apidoc",
     "nipype.sphinxext.plot_workflow",
 ]

docs/examples.rst

@@ -0,0 +1,8 @@
+Examples
+========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   notebooks/SDC - Theory and physics

docs/index.rst

@@ -7,6 +7,7 @@ Contents
     :maxdepth: 3
 
     installation
+    examples
     methods
     api
     changes

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