gh-365: upload HTML rendering of notebooks as artifact

glass-dev · Oct 18, 2024 · 614f214 · 614f214
1 parent e797fe6
commit 614f214
Show file tree

Hide file tree

Showing 10 changed files with 165 additions and 263 deletions.
diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -45,3 +45,9 @@ jobs:
         run: pip install nox
       - name: Run examples
         run: nox -s examples
+      - name: Generate HTML
+        run: nox -s examples -- html
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Examples
+          path: examples/**/*.html
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,4 @@ dist
 .env
 .coverage*
 coverage*
+examples/**/*.html
diff --git a/examples/1-basic/density.ipynb b/examples/1-basic/density.ipynb
diff --git a/examples/1-basic/lensing.ipynb b/examples/1-basic/lensing.ipynb
diff --git a/examples/1-basic/matter.ipynb b/examples/1-basic/matter.ipynb
diff --git a/examples/1-basic/photoz.ipynb b/examples/1-basic/photoz.ipynb
diff --git a/examples/1-basic/shells.ipynb b/examples/1-basic/shells.ipynb
diff --git a/examples/2-advanced/cosmic_shear.ipynb b/examples/2-advanced/cosmic_shear.ipynb
diff --git a/examples/2-advanced/stage_4_galaxies.ipynb b/examples/2-advanced/stage_4_galaxies.ipynb
diff --git a/noxfile.py b/noxfile.py
@@ -47,11 +47,27 @@ 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",
+                "--execute",
+                "examples/**/*.ipynb",
+            )
+        else:
+            print("Unsupported argument to examples")
+    else:
+        session.run(
+            "jupyter", "execute", *Path().glob("examples/**/*.ipynb"), *session.posargs
+        )
 
 
 @nox.session