Merge pull request #65 from PolicyEngine/docs-check

Check for docs errors

.github/workflows/pr.yml

@@ -34,12 +34,15 @@ jobs:
       
       - name: Generate documentation
         run: make documentation
+        env:
+          HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }}
 
       - name: Check documentation build
         run: |
-          if [ -d "docs/_build/html" ]; then
-            echo "Documentation built successfully"
-          else
-            echo "Documentation build failed"
-            exit 1
-          fi
+          for notebook in $(find docs/_build/jupyter_execute -name "*.ipynb"); do
+            if grep -q '"output_type": "error"' "$notebook"; then
+              echo "Error found in $notebook"
+              cat "$notebook"
+              exit 1
+            fi
+          done

.github/workflows/push.yml

@@ -58,6 +58,8 @@ jobs:
 
       - name: Generate documentation
         run: make documentation
+        env:
+          HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }}
 
       - name: Deploy documentation
         uses: JamesIves/github-pages-deploy-action@releases/v3

docs/_config.yml

@@ -5,8 +5,9 @@ copyright: "2025"
 logo: logo.png
 
 execute:
-  execute_notebooks: cache
-  allow_errors: false
+  execute_notebooks: force
+  stderr_output: error
+  timeout: 600
 
 repository:
   url: https://github.com/policyengine/policyengine.py

docs/index.ipynb

@@ -71,16 +71,16 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "130.71499538568372"
+       "130.69994101206225"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 2,
      "metadata": {},
      "output_type": "execute_result"
     }