docs: 📝 Introduce mkdocs-material to sahi project to have documentation page (#1213)

Co-authored-by: fatih akyon <34196005+fcakyon@users.noreply.github.com>

Author: fcakyon

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: 👷
+    target-branch: "main"
+

.github/workflows/ci.yml

@@ -60,7 +60,7 @@ jobs:
       - name: Install dependencies
         run: |
           set -e
-          uv sync --extra dev --extra ci
+          uv sync --group dev --extra ci
       - name: List installed packages
         run: |
           echo "=== Installed Python packages ==="

.github/workflows/mmdet.yml

@@ -93,7 +93,7 @@ jobs:
           # Activate virtual environment
           source .venv/bin/activate
           # Install dev and mmdet dependencies
-          uv sync --extra dev --extra mmdet
+          uv sync --group dev --extra mmdet
           # Install specific torch version for MMDet compatibility AFTER uv sync
           uv pip install torch==2.1.2+cpu torchvision==0.16.2+cpu --index-url https://download.pytorch.org/whl/cpu
       - name: Verify .venv Activation

.github/workflows/publish_docs.yml

@@ -0,0 +1,54 @@
+name: 🛠️ Build and 📚 Publish Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+  release:
+    types: [published]
+
+# Ensure only one concurrent deployment
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name == 'push' && github.ref}}
+  cancel-in-progress: true
+
+# Restrict permissions by default
+permissions:
+  contents: write # Required for committing to gh-pages
+  pages: write # Required for deploying to Pages
+  pull-requests: write # Required for PR comments
+
+jobs:
+  deploy:
+    name: 📚 Publish Docs
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    steps:
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          fetch-depth: 0
+
+      - name: 🐍 Install uv and set Python ${{ matrix.python-version }}
+        uses: astral-sh/setup-uv@e92bafb6253dcd438e0484186d7669ea7a8ca1cc # v6.4.3
+        with:
+          python-version: ${{ matrix.python-version }}
+          activate-environment: true
+
+      - name: 🏗️ Install dependencies
+        run: |
+          uv pip install -r pyproject.toml --group docs
+
+      - name: ⚙️ Configure git for github-actions
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: 📚 Build and Publish Docs
+        if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'workflow_dispatch'
+        run: |
+          uv run mkdocs gh-deploy --force

.github/workflows/ruff.yaml

@@ -30,7 +30,7 @@ jobs:
       - name: Install dependencies
         run: |
           uv venv --python 3.10
-          uv sync --extra dev
+          uv sync --group dev
       - name: Check code formatting
         id: ruff_check
         run: |
@@ -59,4 +59,4 @@ jobs:
           echo "   git push"
           echo ""
           echo "For more details, see CONTRIBUTING.md"
-          exit 1
+          exit 1