From fb124830dbe5ad98bccc83ed76b0b7164918a7cc Mon Sep 17 00:00:00 2001
From: Marcel Arpogaus <38564291+MArpogaus@users.noreply.github.com>
Date: Fri, 12 Jul 2024 15:31:08 +0200
Subject: [PATCH] ci: add gh worklfow for docs

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

diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
new file mode 100644
index 0000000..a30f50c
--- /dev/null
+++ b/.github/workflows/docs.yaml
@@ -0,0 +1,46 @@
+# Adjusted workflow from: https://github.com/mitmproxy/pdoc/blob/25f325d06aaacba9711f957f48e770029f608f6a/.github/workflows/docs.yml
+
+name: Generate documentation using pdoc and deploy as gh page.
+
+# build the documentation whenever there are new commits on main
+on:
+  push:
+    branches:
+    tags:
+    - '*'
+
+# security: restrict permissions for CI jobs.
+permissions:
+  contents: read
+
+jobs:
+  # Build the documentation and upload the static HTML files as an artifact.
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+      # Install all dependencies (including pdoc)
+    - run: pip install -e .[docs]
+    - run: pdoc -d numpy -o docs bernstein_flow
+    - uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs/
+
+  # Deploy the artifact to GitHub pages.
+  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - id: deployment
+      uses: actions/deploy-pages@v4