docs: mkdocs GitHub Pages deploy

.github/workflows/docs.yml

@@ -0,0 +1,55 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build Docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --dev --extra docs
+
+      - name: Build docs
+        run: uv run mkdocs build --strict
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -6,6 +6,9 @@ __pycache__/
 .hypothesis/
 htmlcov/
 
+# MkDocs build output
+site/
+
 # Claude Code (local development only)
 CLAUDE.md
 .claude/

docs/user-guide/ml-readiness.md

@@ -174,5 +174,5 @@ result = result.with_columns(
 
 ## Reference
 
-- See [Feature Registry](../api/registry.md) for full metadata API
-- See [Preprocessing](../api/preprocessing.md) for scaler documentation
+- See [API Reference](../api/index.md) for full metadata API
+- See [Preprocessing](preprocessing.md) for scaler documentation

mkdocs.yml

@@ -3,9 +3,9 @@
 
 site_name: ML4T Engineer
 site_description: High-performance feature engineering for financial machine learning
-site_url: https://ml4t.io/docs/engineer/
-repo_url: https://github.com/stefan-jansen/ml4t-engineer
-repo_name: stefan-jansen/ml4t-engineer
+site_url: https://ml4t.github.io/engineer/
+repo_url: https://github.com/ml4t/engineer
+repo_name: ml4t/engineer
 
 # Theme configuration - Picasso Blue Period palette
 theme:
@@ -119,8 +119,13 @@ nav:
     - Quickstart: getting-started/quickstart.md
   - User Guide:
     - Features: user-guide/features.md
+    - Feature Discovery: user-guide/discovery.md
     - Labeling: user-guide/labeling.md
     - Alternative Bars: user-guide/bars.md
+    - Dataset Builder: user-guide/dataset-builder.md
+    - Preprocessing: user-guide/preprocessing.md
+    - Fractional Differencing: user-guide/fractional-differencing.md
+    - ML Readiness: user-guide/ml-readiness.md
   - API Reference:
     - api/index.md
 

pyproject.toml

@@ -149,11 +149,9 @@ dev = [
 
 # Documentation generation
 docs = [
-    "sphinx>=7.0.0",
-    "sphinx-rtd-theme>=1.3.0",
-    "sphinx-autodoc-typehints>=1.24.0",
-    "myst-parser>=2.0.0",
-    "nbsphinx>=0.9.0",
+    "mkdocs>=1.6,<2",
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings[python]>=0.24.0",
 ]
 
 # Complete installation
@@ -177,16 +175,14 @@ all = [
     "ipdb>=0.13.0",
     "pre-commit>=3.3.0",
     "arch>=6.0.0",
-    "sphinx>=7.0.0",
-    "sphinx-rtd-theme>=1.3.0",
-    "sphinx-autodoc-typehints>=1.24.0",
-    "myst-parser>=2.0.0",
-    "nbsphinx>=0.9.0",
+    "mkdocs>=1.6,<2",
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings[python]>=0.24.0",
 ]
 
 [project.urls]
 Homepage = "https://github.com/stefan-jansen/ml4t-engineer"
-Documentation = "https://ml4t-engineer.readthedocs.io"
+Documentation = "https://ml4t.github.io/engineer/"
 Repository = "https://github.com/stefan-jansen/ml4t-engineer"
 Issues = "https://github.com/stefan-jansen/ml4t-engineer/issues"
 Changelog = "https://github.com/stefan-jansen/ml4t-engineer/blob/main/CHANGELOG.md"