Setup Zensical for Documentation Site and GHA workflow (#81)

* Add 'site' to .gitignore for improved file management

* feat: add zensical

* chore: update lock file

* feat: add initial zensical configuration file

* feat: add initial documentation index file

* feat: add GitHub Actions workflow for documentation deployment

* ci: improve GitHub Actions workflow for documentation deployment

* refactor: reorganize dependency groups in pyproject.toml and move zensical to docs dep group

Author: HYP3R00T

.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+name: Documentation
+on:
+    push:
+        branches:
+            - main
+        paths:
+            - "docs/**"
+            - "zensical.toml"
+    workflow_dispatch:
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+jobs:
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v6
+
+            - uses: actions/configure-pages@v5
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@v7
+              with:
+                  enable-cache: true
+
+            - name: Install docs dependencies via uv
+              run: uv sync --locked --only-group docs
+
+            - name: Build docs with zensical via uv
+              run: uv run zensical build --clean
+
+            - uses: actions/upload-pages-artifact@v4
+              with:
+                  path: site
+
+            - uses: actions/deploy-pages@v4
+              id: deployment

.gitignore

@@ -45,3 +45,5 @@ VideoMaMaInferenceModule/checkpoints/*
 !VideoMaMaInferenceModule/checkpoints/.gitkeep
 gvm_core/weights/*
 !gvm_core/weights/.gitkeep
+
+site

docs/index.md

@@ -16,7 +16,6 @@ dependencies = [
     "opencv-python",
     "tqdm",
     "setuptools",
-
     # GVM alpha hint generator
     "diffusers",
     "transformers",
@@ -28,21 +27,16 @@ dependencies = [
     "easydict",
     "imageio",
     "matplotlib",
-
     # VideoMaMa alpha hint generator
     "einops",
-
     # CLI tools (huggingface-hub is also a transitive dep, but must be direct
     # so that uv installs the "hf" console-script entry point)
     "huggingface-hub",
 ]
 
 [dependency-groups]
-dev = [
-    "pytest",
-    "pytest-cov",
-    "ruff",
-]
+dev = ["pytest", "pytest-cov", "ruff"]
+docs = ["zensical>=0.0.24"]
 
 [project.scripts]
 corridorkey = "corridorkey_cli:main"
@@ -83,7 +77,7 @@ omit = [
     "gvm_core/*",
     "VideoMaMaInferenceModule/*",
     "tests/*",
-    "test_vram.py",  # manual GPU smoke test, not part of the pytest suite
+    "test_vram.py",               # manual GPU smoke test, not part of the pytest suite
 ]
 
 [[tool.uv.index]]