From c10413c5c480c2573bf38c00f7010b916ca04c6c Mon Sep 17 00:00:00 2001
From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com>
Date: Mon, 1 May 2023 14:42:16 -0400
Subject: [PATCH 1/3] pdoc

automated pdoc documentation
---
 .github/workflows/static.yml | 49 ++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 .github/workflows/static.yml

diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
new file mode 100644
index 0000000..f8c5491
--- /dev/null
+++ b/.github/workflows/static.yml
@@ -0,0 +1,49 @@
+name: website
+
+# build the documentation whenever there are new commits on main
+on:
+  push:
+    branches:
+      - main
+    # 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@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      # ADJUST THIS: install all dependencies (including pdoc)
+      - run: pip install -e .
+      # ADJUST THIS: build your documentation into docs/.
+      # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
+      - run: python docs/make.py
+
+      - uses: actions/upload-pages-artifact@v1
+        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@v2

From c28ba5a665652fdf2da7fb47e9838989467fd750 Mon Sep 17 00:00:00 2001
From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com>
Date: Mon, 1 May 2023 14:44:37 -0400
Subject: [PATCH 2/3] Update and rename static.yml to pdoc.yml

---
 .github/workflows/{static.yml => pdoc.yml} | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
 rename .github/workflows/{static.yml => pdoc.yml} (97%)

diff --git a/.github/workflows/static.yml b/.github/workflows/pdoc.yml
similarity index 97%
rename from .github/workflows/static.yml
rename to .github/workflows/pdoc.yml
index f8c5491..ed68d14 100644
--- a/.github/workflows/static.yml
+++ b/.github/workflows/pdoc.yml
@@ -27,7 +27,7 @@ jobs:
       - run: pip install -e .
       # ADJUST THIS: build your documentation into docs/.
       # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
-      - run: python docs/make.py
+      - run: pdoc -o docs/ ...
 
       - uses: actions/upload-pages-artifact@v1
         with:

From e6c243debb7af641535b237ad04b95dd35b7e2ef Mon Sep 17 00:00:00 2001
From: hwelch-fle <91618355+hwelch-fle@users.noreply.github.com>
Date: Mon, 1 May 2023 14:46:26 -0400
Subject: [PATCH 3/3] Added Docs Link

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 9cd8a0e..5011231 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,4 @@
 # plankapy
 A python 3 based API for controlling a self-hosted Planka instance
+
+[Docs](https://hwelch-fle.github.io)