Merge pull request #519 from laughingman7743/#501

.github/workflows/docs.yaml

@@ -0,0 +1,48 @@
+name: Docs
+
+on:
+  workflow_dispatch:
+  push:
+    branches: ["master"]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      PYTHON_VERSION: "3.11"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Install hatch
+        run: pipx install hatch
+      - run: |
+          hatch run make docs
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs/_build/html'
+
+  deploy:
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -20,3 +20,4 @@ cover/
 .mypy_cache
 .tmp
 .venv
+docs/_build

Makefile

@@ -33,3 +33,7 @@ upgrade-lock:
 	rm -rf ./requirements/
 	PIP_COMPILE_UPGRADE=1 hatch env run -- python --version
 	PIP_COMPILE_UPGRADE=1 hatch env run --env test -- python --version
+
+.PHONY: docs
+docs:
+	cd ./docs && $(MAKE) clean html