gh-365: upload HTML rendering of notebooks as artifact

.github/workflows/examples.yml

@@ -52,3 +52,11 @@ jobs:
         run: nox -s examples
         env:
           FORCE_COLOR: 1
+      - name: Generate HTML
+        run: nox -s examples -- html
+        env:
+          FORCE_COLOR: 1
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Examples
+          path: examples/**/*.html

.gitignore

@@ -9,3 +9,4 @@ dist
 .env
 .coverage*
 coverage*
+examples/**/*.html

.pre-commit-config.yaml

@@ -71,3 +71,9 @@ repos:
       - id: mypy
         additional_dependencies:
           - numpy
+  - repo: https://github.com/kynan/nbstripout
+    rev: 0.7.1
+    hooks:
+      - id: nbstripout
+        args:
+          - --keep-output

noxfile.py

@@ -47,14 +47,29 @@ def doctests(session: nox.Session) -> None:
 
 @nox.session
 def examples(session: nox.Session) -> None:
-    """Run the example notebooks."""
+    """Run the example notebooks. Pass "html" to build html."""
     session.install("-e", ".[examples]")
-    session.run(
-        "jupyter",
-        "execute",
-        *Path().glob("examples/**/*.ipynb"),
-        *session.posargs,
-    )
+
+    if session.posargs:
+        if "html" in session.posargs:
+            print("Generating HTML for the example notebooks")
+            session.run(
+                "jupyter",
+                "nbconvert",
+                "--to",
+                "html",
+                "--embed-images",
+                "examples/**/*.ipynb",
+            )
+        else:
+            print("Unsupported argument to examples")
+    else:
+        session.run(
+            "jupyter",
+            "execute",
+            *Path().glob("examples/**/*.ipynb"),
+            *session.posargs,
+        )
 
 
 @nox.session