From c90a75d692796cd1a6d8b035f770fd432e3f54e5 Mon Sep 17 00:00:00 2001
From: Harriet Dashnow <h.dashnow@gmail.com>
Date: Tue, 25 Nov 2025 13:22:42 -0700
Subject: [PATCH 1/5] update documentation creation

---
 .github/workflows/docs.yml | 58 ++++++++++++++++++++++++++++++++++++++
 docs/requirements.txt      |  7 +++++
 2 files changed, 65 insertions(+)
 create mode 100644 .github/workflows/docs.yml
 create mode 100644 docs/requirements.txt

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..7559ca8
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,58 @@
+# Minimal Sphinx docs build + deploy workflow
+# - Adjust `working-directory` or the `make -C` path to point where your Makefile lives.
+# - Ensure docs/requirements.txt exists or set pip install fallback packages.
+name: docs
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+
+      - name: Install docs dependencies
+        run: |
+          if [ -f docs/requirements.txt ]; then
+            pip install -r docs/requirements.txt
+          else
+            pip install sphinx sphinx-rtd-theme
+          fi
+
+      - name: Build docs (make html)
+        # run from repo root and invoke Makefile in docs/; change -C if Makefile is at repo root
+        run: make -C docs html
+        # If your Makefile is at repo root and SOURCEDIR points to docs/source, use: run: make html
+
+      - name: Copy built html for pages
+        run: |
+          mkdir -p out
+          cp -r docs/build/html/* out/
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v1
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v1
\ No newline at end of file
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..e74bba9
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,7 @@
+# Python dependencies for building STRling documentation
+sphinx
+sphinx_rtd_theme
+numpy
+pandas
+scipy
+statsmodels

From 0ae307396d2ccd542bac6cac5b185c0c5028ac6b Mon Sep 17 00:00:00 2001
From: Harriet Dashnow <h.dashnow@gmail.com>
Date: Tue, 25 Nov 2025 13:26:51 -0700
Subject: [PATCH 2/5] run docs manually

---
 .github/workflows/docs.yml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 7559ca8..e98d774 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -10,6 +10,7 @@ on:
     paths:
       - 'docs/**'
       - '.github/workflows/docs.yml'
+  workflow_dispatch:
 
 jobs:
   build:

From f68a08fdfdb509bb2c8389ff1dd71e2eb3e0da6e Mon Sep 17 00:00:00 2001
From: Harriet Dashnow <h.dashnow@gmail.com>
Date: Tue, 25 Nov 2025 13:29:53 -0700
Subject: [PATCH 3/5] upload version

---
 .github/workflows/docs.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index e98d774..ed871e8 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -46,7 +46,7 @@ jobs:
           cp -r docs/build/html/* out/
 
       - name: Upload Pages artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v4
 
   deploy:
     needs: build

From 5e9a0156b5a6b5f52eca56524d88fd1faabaf6f9 Mon Sep 17 00:00:00 2001
From: Harriet Dashnow <h.dashnow@gmail.com>
Date: Fri, 5 Dec 2025 16:14:03 -0700
Subject: [PATCH 4/5] fix docs

---
 .github/workflows/docs.yml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index ed871e8..960186d 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -42,8 +42,8 @@ jobs:
 
       - name: Copy built html for pages
         run: |
-          mkdir -p out
-          cp -r docs/build/html/* out/
+          mkdir -p _site
+          cp -r docs/build/html/* _site/
 
       - name: Upload Pages artifact
         uses: actions/upload-pages-artifact@v4

From c9bb6d2f554078b44006556db32f036dbdc109f6 Mon Sep 17 00:00:00 2001
From: Harriet Dashnow <h.dashnow@gmail.com>
Date: Fri, 5 Dec 2025 16:17:13 -0700
Subject: [PATCH 5/5] update permissions

---
 .github/workflows/docs.yml | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 960186d..d31b379 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -12,6 +12,11 @@ on:
       - '.github/workflows/docs.yml'
   workflow_dispatch:
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
   build:
     runs-on: ubuntu-latest