feat: add GitHub Pages deployment workflow

- Add GitHub Actions workflow for automatic deployment
- Create docs/requirements.txt for documentation dependencies
- Remove mkdocs-jupyter plugin from mkdocs.yml
- Remove docs/examples symlink to exclude .ipynb files from docs
- Use latest action versions (v4, v5) to avoid deprecation warnings

Author: XiaoBoAI

.github/workflows/deploy-docs.yml

@@ -0,0 +1,45 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Cache pip dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -r docs/requirements.txt
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Build and deploy to GitHub Pages
+        run: mkdocs gh-deploy --force --clean

docs/examples

@@ -0,0 +1,5 @@
+mkdocs>=1.5.0
+mkdocs-material>=9.0.0
+mkdocstrings[python]>=0.24.0
+pymdown-extensions>=10.0
+mkdocs-shadcn>=0.1.0

docs/requirements.txt

@@ -67,7 +67,6 @@ plugins:
       min_search_length: 2
       prebuild_index: true
       indexing: 'full'
-  - mkdocs-jupyter
   - mkdocstrings:
       handlers:
         python: