Adds docs

.github/workflows/CI.yml

@@ -49,7 +49,7 @@ jobs:
           uv venv .test-venv
           source .test-venv/bin/activate
           uv pip install dist/*.whl --reinstall
-          uv pip install --group dev --group examples
+          uv pip install --group dev --group docs --group examples
           pytest -v
 
       - uses: actions/upload-artifact@v5
@@ -104,7 +104,7 @@ jobs:
           uv pip install dist/*.whl --reinstall
 
           # Install dev dependencies from pyproject.toml using pip interface
-          uv pip install --group dev --group examples
+          uv pip install --group dev --group docs --group examples
 
           # Run tests directly
           pytest -v
@@ -132,7 +132,7 @@ jobs:
           sudo apt-get install -y llvm-18-dev libclang-18-dev libzstd-dev libpolly-18-dev patchelf
 
       - name: Generate stubs
-        run: cargo run -p chronopt-py --no-default-features --features stubgen --bin generate_stubs
+        run: cargo run -p diffid-py --no-default-features --features stubgen --bin generate_stubs
         env:
           LLVM_SYS_181_PREFIX: /usr/lib/llvm-18
           LIBCLANG_PATH: /usr/lib/llvm-18/lib

.github/workflows/docs.yml

@@ -0,0 +1,59 @@
+name: Documentation
+
+on:
+  push:
+    branches: ["main"]
+    tags:
+      - '*'
+  pull_request:
+  workflow_dispatch:
+
+# Prevent concurrent deployments
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+# Default permissions: read-only
+permissions:
+  contents: read
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch all history for git-revision-date plugin
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Cache uv dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/uv
+          key: ${{ runner.os }}-uv-docs-deploy-${{ hashFiles('.github/workflows/docs.yml') }}
+          restore-keys: |
+            ${{ runner.os }}-uv-docs-deploy-
+
+      - name: Install dependencies
+        run: uv pip install --system --group docs
+
+      - name: Build documentation
+        run: mkdocs build --strict
+
+      - name: Deploy to GitHub Pages
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          cname: false  # Set to your custom domain if you have one

.github/workflows/release.yml

@@ -50,7 +50,7 @@ jobs:
           uv venv .test-venv
           source .test-venv/bin/activate
           uv pip install dist/*.whl --reinstall
-          uv pip install --group dev --group examples
+          uv pip install --group dev --group docs --group examples
           pytest -v
 
       - uses: actions/upload-artifact@v5
@@ -106,7 +106,7 @@ jobs:
           uv pip install dist/*.whl --reinstall
 
           # Install dev dependencies from pyproject.toml using pip interface
-          uv pip install --group dev --group examples
+          uv pip install --group dev --group docs --group examples
 
           # Run tests directly
           pytest -v
@@ -134,7 +134,7 @@ jobs:
           sudo apt-get install -y llvm-18-dev libclang-18-dev libzstd-dev libpolly-18-dev patchelf
 
       - name: Generate stubs
-        run: cargo run -p chronopt-py --no-default-features --features stubgen --bin generate_stubs
+        run: cargo run -p diffid-py --no-default-features --features stubgen --bin generate_stubs
         env:
           LLVM_SYS_181_PREFIX: /usr/lib/llvm-18
           LIBCLANG_PATH: /usr/lib/llvm-18/lib

.gitignore

@@ -65,6 +65,9 @@ coverage.xml
 # Sphinx documentation
 docs/_build/
 
+# MkDocs documentation
+site/
+
 # PyCharm
 .idea/