Build and deploy pdoc with gitnub action

Instead of having generated files checked in to the repo.
mosbth · Oct 15, 2024 · 32806ee · 32806ee
1 parent 8586646
commit 32806ee
Show file tree

Hide file tree

Showing 12 changed files with 33 additions and 9,887 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -48,3 +48,34 @@ jobs:
         uses: ./.github/actions/install
       - name: Lint with Pylint
         run: make pylint
+
+  build:
+    runs-on: ubuntu-24.04
+    needs: [install]
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        uses: ./.github/actions/install
+      - name: Build pdoc
+        id: build
+        run: make pdoc
+      - name: Upload pdoc
+        id: deploy
+        uses: actions/[email protected]
+        with:
+          path: docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-24.04
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deploy
+        uses: actions/[email protected]
+    permissions:
+      id-token: write
+      pages: write
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@ aggregate.error
 aggregate.ignore
 aggregate.log
 db.sqlite
+docs/
 logs/
 # pycharm
 .idea/
@@ -16,4 +17,4 @@ build/
 .venv
 __pycache__/
 data/marvinMorning_date.txt
-.coverage
+.coverage
diff --git a/docs/pdoc/bot.html b/docs/pdoc/bot.html
diff --git a/docs/pdoc/discord_bot.html b/docs/pdoc/discord_bot.html
diff --git a/docs/pdoc/index.html b/docs/pdoc/index.html
diff --git a/docs/pdoc/irc_bot.html b/docs/pdoc/irc_bot.html
diff --git a/docs/pdoc/main.html b/docs/pdoc/main.html
diff --git a/docs/pdoc/marvin_actions.html b/docs/pdoc/marvin_actions.html
diff --git a/docs/pdoc/marvin_general_actions.html b/docs/pdoc/marvin_general_actions.html
diff --git a/docs/pdoc/search.js b/docs/pdoc/search.js
diff --git a/docs/pdoc/test_main.html b/docs/pdoc/test_main.html
diff --git a/docs/pdoc/test_marvin_actions.html b/docs/pdoc/test_marvin_actions.html