feat: docs

Author: bofei5675

.github/workflows/deploy-docs.yml

@@ -0,0 +1,22 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - feat/docs  # Or your default branch
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin pymdown-extensions
+      - name: Deploy to GitHub Pages
+        run: |
+          mkdocs gh-deploy --force --clean 

.gitignore

@@ -72,4 +72,5 @@ pylintrc
 .ruff_cache
 
 
-test.py
+test.py
+site