From bcaab148ae32395bca027b7834a72dfa83b186b2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dirk=20G=C3=BCtlin?=
 <34550289+DiGyt@users.noreply.github.com>
Date: Thu, 19 Jun 2025 15:42:33 +0200
Subject: [PATCH] create workflow to automatically update docs

---
 .github/workflows/docs.yml | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 .github/workflows/docs.yml

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..692ae53
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,37 @@
+name: Build and Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'asrpy/**'
+      - 'setup.py'
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install pdoc3
+
+      - name: Generate HTML docs
+        run: pdoc3 --html --output-dir docs asrpy -f -c sort_identifiers=False
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/asrpy  # pdoc3 puts output in docs/asrpy by default