Merge pull request #96 from PolicyEngine/docs-fix

Add extra check in docs build artifacts for errors

Author: nikhilwoodruff

.github/workflows/any_changes.yaml

@@ -13,16 +13,28 @@ jobs:
       steps:
         - name: Checkout repo
           uses: actions/checkout@v2
+        - name: Install uv
+          uses: astral-sh/setup-uv@v5
 
         - name: Set up Python
           uses: actions/setup-python@v2
           with:
             python-version: '3.10'
-            
+              
         - name: Install package
-          run: make install
+          run: uv pip install .[dev] --system
 
         - name: Test documentation builds
           run: make documentation
           env:
-            HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }}
+            HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }}
+
+        - name: Check documentation build
+          run: |
+            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/publish_package.yaml

@@ -10,15 +10,19 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v5
+        uses: actions/checkout@v2
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
         with:
-          python-version: 3.12
+          python-version: '3.10'
+            
+      - name: Install package
+        run: uv pip install .[dev] --system
       - name: Publish a git tag
         run: ".github/publish-git-tag.sh || true"
-      - name: Install package
-        run: make install
       - name: Build package
         run: make
       - name: Publish a Python distribution to PyPI

docs/basic/calculate_economy_comparison.ipynb

@@ -149,7 +149,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.14"
+   "version": "3.12.9"
   }
  },
  "nbformat": 4,

docs/basic/calculate_household_comparison.ipynb

@@ -114,7 +114,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.14"
+   "version": "3.12.9"
   }
  },
  "nbformat": 4,

docs/basic/calculate_single_economy.ipynb

@@ -11,7 +11,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -34,14 +34,14 @@
     "from policyengine import Simulation\n",
     "from policyengine.outputs.macro.comparison.charts import *\n",
     "\n",
-    "sim = Simulation({\n",
-    "    \"country\": \"uk\",\n",
-    "    \"scope\": \"macro\",\n",
-    "    \"reform\": {\n",
+    "sim = Simulation(\n",
+    "    country=\"uk\",\n",
+    "    scope=\"macro\",\n",
+    "    reform={\n",
     "        \"gov.hmrc.income_tax.allowances.personal_allowance.amount\": 10_000,\n",
     "    },\n",
-    "    \"title\": \"Lowering the personal allowance to £10,000\" # Required for charts\n",
-    "})\n",
+    "    title=\"Lowering the personal allowance to £10,000\" # Required for charts\n",
+    ")\n",
     "\n",
     "from policyengine.utils.charts import add_fonts\n",
     "\n",

docs/basic/calculate_single_household.ipynb

@@ -22,7 +22,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -39,12 +39,12 @@
    "source": [
     "from policyengine import Simulation\n",
     "\n",
-    "sim = Simulation({\n",
-    "    \"country\": \"uk\",\n",
-    "    \"scope\": \"macro\",\n",
-    "    \"reform\": {},\n",
-    "    \"time_period\": 2025,\n",
-    "})\n",
+    "sim = Simulation(\n",
+    "    country=\"uk\",\n",
+    "    scope=\"macro\",\n",
+    "    reform={},\n",
+    "    time_period=2025,\n",
+    ")\n",
     "\n",
     "sim.calculate_economy_comparison()"
    ]

docs/basic/create_charts.ipynb

@@ -27,7 +27,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -44,14 +44,14 @@
    "source": [
     "from policyengine import Simulation\n",
     "\n",
-    "sim = Simulation({\n",
-    "    \"scope\": \"macro\",\n",
-    "    \"country\": \"uk\",\n",
-    "    \"time_period\": 2025,\n",
-    "    \"reform\": {\n",
+    "sim = Simulation(\n",
+    "    scope=\"macro\",\n",
+    "    country=\"uk\",\n",
+    "    time_period=2025,\n",
+    "    reform={\n",
     "        \"gov.hmrc.income_tax.allowances.personal_allowance.amount\": 15000\n",
     "    },\n",
-    "})\n",
+    ")\n",
     "\n",
     "sim.calculate_economy_comparison()"
    ]

docs/concepts/simulation.ipynb

@@ -38,7 +38,7 @@ def calculate_single_household(
     """Calculate household statistics for a single household scenario."""
     if simulation.is_comparison:
         raise ValueError(
-            "This function is for single economy simulations only."
+            "This function is for single household simulations only."
         )
 
     return SingleHousehold(