Check example notebooks

.github/workflows/test-notebooks.yml

@@ -0,0 +1,43 @@
+name: Notebooks
+
+on: [push, pull_request]
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  test-notebooks:
+    name: Check notebooks
+    if:
+      github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+
+    runs-on: ${{ matrix.os }}
+
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+          miniforge-variant: Miniforge3
+          miniforge-version: latest
+          auto-update-conda: true
+
+      - name: Install nox
+        run: pip install nox
+
+      - name: Check Jupyter notebooks
+        env:
+          MPLBACKEND: "Agg"
+        run: |
+          nox --verbose -s check-notebooks --force-pythons="${{ matrix.python-version }}"

.github/workflows/test.yml

@@ -9,6 +9,7 @@ concurrency:
 jobs:
 
   test:
+    name: Run unit tests
     if:
       github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
       github.repository

noxfile.py

@@ -57,6 +57,23 @@ def test_cli(session: nox.Session) -> None:
     session.run(PROJECT, "--help")
 
 
+@nox.session(name="check-notebooks", python=PYTHON_VERSIONS[-1])
+def check_notebooks(session: nox.Session) -> None:
+    """Run the example notebooks."""
+    session.install(".[testing,examples]")
+    session.install("nbmake")
+
+    args = [
+        "examples",
+        "--nbmake",
+        "--nbmake-kernel=python3",
+        "--nbmake-timeout=3000",
+        "-vvv",
+    ] + session.posargs
+
+    session.run("pytest", *args)
+
+
 @nox.session
 def lint(session: nox.Session) -> None:
     """Clean lint and assert style."""

pyproject.toml

@@ -101,6 +101,7 @@ addopts = """
   --durations 16
   --doctest-modules
   -vvv
+  --ignore-glob=examples/*.py
 """
 doctest_optionflags = [
   "NORMALIZE_WHITESPACE",