Migrate documentation build to mkdocs

.github/workflows/docs.yml

@@ -0,0 +1,100 @@
+name: docs
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/docs.yml
+      - '**.py'
+      - '**.ipynb'
+      - '**.html'
+      - '**.js'
+      - '**.md'
+      - uv.lock
+      - pyproject.toml
+      - mkdocs.yml
+      - '**.png'
+      - '**.svg'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - .pre-commit-config.yaml
+      - .github/workflows/docs.yml
+      - '**.py'
+      - '**.ipynb'
+      - '**.js'
+      - '**.html'
+      - uv.lock
+      - pyproject.toml
+      - '**.md'
+      - mkdocs.yml
+      - '**.png'
+      - '**.svg'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4.2.2
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@0c5e2b8115b80b4c7c5ddf6ffdd634974642d182
+        with:
+          version: "0.5.21"
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install the project
+        run: uv sync --all-extras --all-groups
+
+      - name: Build docs
+        run: uv run mkdocs build
+
+      - name: Create .nojekyll file
+        run: touch site/.nojekyll
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-site
+          path: site/
+          retention-days: 1
+
+  deploy:
+    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4.2.2
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: docs-site
+          path: site
+
+      - name: Ensure .nojekyll exists
+        run: touch site/.nojekyll
+
+      - name: Deploy to Github pages
+        uses: JamesIves/github-pages-deploy-action@6c2d9db40f9296374acc17b90404b6e8864128c8
+        with:
+          branch: github_pages
+          folder: site

.pre-commit-config.yaml

@@ -12,7 +12,11 @@ repos:
       - id: mixed-line-ending
         args: [--fix=lf]
       - id: detect-private-key
+      - id: check-byte-order-marker
+      - id: check-merge-conflict
+      - id: check-symlinks
       - id: check-yaml
+        args: [--unsafe]
       - id: check-toml
 
   - repo: https://github.com/astral-sh/uv-pre-commit

docs/api.md

@@ -0,0 +1,104 @@
+# API Reference
+
+## Top Level Module
+
+::: mmlearn
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+## CLI Module
+
+::: mmlearn.cli
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+## Configuration Module
+
+::: mmlearn.conf
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+## Datasets Module
+
+::: mmlearn.datasets
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+### Core Datasets Components
+
+::: mmlearn.datasets.core
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+### Dataset Processors
+
+::: mmlearn.datasets.processors
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+## Modules
+
+::: mmlearn.modules
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+### Encoders
+
+::: mmlearn.modules.encoders
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+### Layers
+
+::: mmlearn.modules.layers
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+### Losses
+
+::: mmlearn.modules.losses
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+### Learning Rate Schedulers
+
+::: mmlearn.modules.lr_schedulers
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+### Metrics
+
+::: mmlearn.modules.metrics
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+## Tasks
+
+::: mmlearn.tasks
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+## Utilities
+
+::: mmlearn.hf_utils
+    options:
+      show_root_heading: true
+      show_root_full_path: true
+
+::: mmlearn.constants
+    options:
+      show_root_heading: true
+      show_root_full_path: true