Add doc publishing workflow (#18)

Author: zombie-einstein

.github/workflows/publish_docs.yaml

@@ -0,0 +1,40 @@
+name: publish-docs
+run-name: ${{ github.actor }} publish-docs
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install hatch 🐣
+        run: pip install hatch
+      - name: Build docs 📚
+        run: hatch run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3.0.0
+        with:
+          path: docs/build
+
+  publish_docs:
+    runs-on: ubuntu-latest
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4