WIP: Trying to incorporate a notebook into the doc build.

.github/workflows/docbuild.yml

@@ -27,7 +27,7 @@ jobs:
         XVFB: 1
       run: |
         cd docs
-        make html
+        python -m sphinx source build -j 4
     - name: Upload docs
       uses: actions/upload-artifact@v1
       with:

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: local
+    hooks:
+      - id: jupyter-nb-clear-output
+        name: jupyter-nb-clear-output
+        files: \.ipynb$
+        stages: [commit]
+        language: system
+        entry: jupyter nbconvert --ClearOutputPreprocessor.enabled=True --inplace

docs/source/conf.py

@@ -62,6 +62,7 @@
     'kwargsdocs',
     'methodsdocs',
     'myst_nb',
+    'nbsphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

examples/howto_examples/plot_test_nbsphinx.ipynb

@@ -0,0 +1,51 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import matplotlib.pyplot as plt\n",
+    "import numpy as np\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "plt.plot(np.random.rand(10))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "afq",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

setup.cfg

@@ -74,6 +74,7 @@ dev =
     pydata-sphinx-theme
     sphinx-design
     myst-nb
+    nbsphinx
 fury =
     fury==0.8.0
     xvfbwrapper==0.2.9