From 47bbf34137ab8d274710962b6ec1d4d699a4423b Mon Sep 17 00:00:00 2001
From: object-Object <object@objectobject.ca>
Date: Sat, 4 Nov 2023 23:53:38 -0400
Subject: [PATCH] Add pdoc workflow

---
 .github/workflows/pdoc.yml | 44 ++++++++++++++++++++++++++++++++++++++
 pyproject.toml             |  5 ++++-
 2 files changed, 48 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/pdoc.yml

diff --git a/.github/workflows/pdoc.yml b/.github/workflows/pdoc.yml
new file mode 100644
index 00000000..6449eb9a
--- /dev/null
+++ b/.github/workflows/pdoc.yml
@@ -0,0 +1,44 @@
+name: Deploy pdoc
+
+on:
+  push:
+    branches: main
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - run: pip install -e .[pdoc] hatch
+      - run: |-
+          pdoc hexdoc
+            --edit-url hexdoc=https://github.com/object-Object/hexdoc/blob/main/src/hexdoc/
+            --favicon https://github.com/object-Object/hexdoc/raw/main/media/hexdoc.png
+            --footer-text "hexdoc $(hatch version) ($(git rev-parse --short HEAD))"
+            --logo https://github.com/object-Object/hexdoc/raw/main/media/hexdoc.png
+            --logo-link https://pypi.org/project/hexdoc/
+            --output-directory docs/
+
+      - uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs/
+
+  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
diff --git a/pyproject.toml b/pyproject.toml
index e7b3d3ae..a6fb75d8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -56,13 +56,16 @@ favicons = [
     # TODO: move this back to the main deps list when they fix the dependency conflict
     "favicons~=0.2",
 ]
+pdoc = [
+    "pdoc~=14.1",
+]
 test = [
     "pytest~=7.4",
     "pytest-dependency~=0.5.1",
     "syrupy~=4.6",
 ]
 dev = [
-    "hexdoc[test]",
+    "hexdoc[favicons,pdoc,test]",
     "black==23.7.0",
     "isort==5.12.0",
     "hatch",