Add Docs Preview for PRs

.github/workflows/preview-docs.yml

@@ -0,0 +1,29 @@
+name: Preview Docs
+on:
+  workflow_run:
+    workflows:
+      - Test suite
+    types:
+      - completed
+jobs:
+  preview-docs:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+      - name: Install Dependencies
+        run: pip install hatch
+      - run: hatch run docs_build
+      - name: Deploy to Netlify
+        uses: nwtgck/[email protected]
+        with:
+          publish-dir: './site'
+          production-deploy: false
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+        env:
+          NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+          NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+        timeout-minutes: 1

pyproject.toml

@@ -89,6 +89,7 @@ cov = [
     "coverage xml"
 ]
 docs = "mkdocs serve -a localhost:8080"
+docs_build = "mkdocs build"
 docs_deploy = "mkdocs gh-deploy --force"
 test = "coverage run -m pytest tests"
 test_sqla = "coverage run -m pytest tests/sqla"