Fix docs deployment

.github/workflows/code-check.yml

@@ -0,0 +1,51 @@
+name: Code Quality Check
+
+on: [pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+
+    - name: Run linting checks
+      run: |
+        nox -s pre-commit ruff mypy
+
+  test:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+
+    - name: Run tests
+      run: |
+        nox -s tests

.github/workflows/docs.yml

@@ -0,0 +1,58 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - '.github/workflows/docs.yml'
+      - 'pyproject.toml'
+      - 'requirements*.txt'
+      - 'noxfile.py'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - '.github/workflows/docs.yml'
+      - 'pyproject.toml'
+      - 'requirements*.txt'
+      - 'noxfile.py'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+
+      - name: Configure Git
+        if: github.event_name == 'push'
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Build documentation
+        if: github.event_name == 'pull_request'
+        run: |
+          nox -s docs -- build
+
+      - name: Deploy documentation
+        if: github.event_name == 'push'
+        run: |
+          nox -s docs -- deploy

.github/workflows/python-publish.yml

@@ -14,30 +14,37 @@ jobs:
       contents: write
 
     steps:
-    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+    - uses: actions/checkout@v4
       with:
         token: "${{ secrets.GITHUB_TOKEN }}"
         fetch-depth: 0
         ref: main
+
     - uses: olegtarasov/[email protected]
       id: get_tag_name
       with:
         tagRegex: "v(?<version>.*)"
+
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.x'
+        python-version: '3.9'
+        cache: 'pip'
+
     - name: Install dependencies
       run: |
-        python -m pip install -U pip poetry mkdocs mkdocs-material
-        poetry --version
-        poetry build
-    # Note that we don't need credentials.
-    # We rely on https://docs.pypi.org/trusted-publishers/.
+        python -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+
+    - name: Build package
+      run: |
+        nox -s build
+
     - name: Upload to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
       with:
         packages-dir: dist
+
     - name: Generate changelog
       id: changelog
       uses: jaywcjlove/changelog-generator@main
@@ -50,12 +57,23 @@ jobs:
           {{fix}}
           ## Feature
           {{feat}}
-          ## Improve
-          {{refactor,perf,clean}}
-          ## Misc
-          {{chore,style,ci||🔶 Nothing change}}
-          ## Unknown
-          {{__unknown__}}
+          ## Breaking Changes
+          {{breaking}}
+          ## Updates
+          {{chore}}
+          ## Document
+          {{docs}}
+          ## Dependency
+          {{deps}}
+          ## Style
+          {{style}}
+          ## Test
+          {{test}}
+          ## CI
+          {{ci}}
+          ## Other
+          {{other}}
+
     - uses: ncipollo/release-action@v1
       with:
         artifacts: "dist/*.whl"

.gitignore

@@ -6,7 +6,14 @@
 
 # Vim / Notepad++ temp files
 *~
-.*/
+
+# Specific dot directories to ignore (but not .github)
+.pytest_cache/
+.mypy_cache/
+.tox/
+.venv/
+.coverage/
+
 *.egg-info
 # PyInstaller output
 build/
@@ -24,3 +31,8 @@ venv_python
 
 # Docs
 docs_src/_build/
+/run_pycharm.bat
+
+
+# windsurf rules
+.windsurfrules