From f2a30f2f72908d975f741c2dab30c4726a6c2774 Mon Sep 17 00:00:00 2001
From: Marcel Arpogaus <38564291+MArpogaus@users.noreply.github.com>
Date: Mon, 19 Feb 2024 13:29:58 +0100
Subject: [PATCH] ci: add workflow to build and deploy docs ad gh page

---
 .github/workflows/docs.yaml | 48 +++++++++++++++++++++++++++++++++++++
 pyproject.toml              |  3 +++
 2 files changed, 51 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..6fffdc8
--- /dev/null
+++ b/.github/workflows/docs.yaml
@@ -0,0 +1,48 @@
+# 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:
+    - dev
+    # Alternative: only build for tags.
+    # 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.12'
+
+      # Install all dependencies (including pdoc)
+    - run: pip install -e .[docs]
+    - run: pdoc -d numpy -o docs tensorflow_time_series_dataset
+    - 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
diff --git a/pyproject.toml b/pyproject.toml
index f632006..30e0081 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -42,6 +42,9 @@ develop = [
   'python-lsp-server[all]',
   'ruff'
 ]
+docs = [
+  'pdoc'
+]
 test = [
   'pytest',
   'pytest-xdist'