docs: MkDocs Material site with API reference and example report

- mkdocs.yml: Material theme + mkdocstrings (API auto-generated from docstrings)
- home / usage / API-reference pages; standalone report linked as example-report.html
- 'docs' optional-dependency group; GitHub Pages deploy workflow (Actions)
- replace the root report demo (docs/index.html) with the docs site

Author: sanjaysgk

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+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-deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # hatch-vcs needs full history for the version
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install -e ".[docs]"
+      - run: mkdocs build
+      - uses: actions/configure-pages@v5
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -12,6 +12,8 @@ data/*html
 !data/ref_data/Gibbs_motifs_mouse/motif/*.png 
 output/*
 .DS_Store
+# MkDocs build output
+/site/
 cli/*__pycache__
 test_output
 poetry.lock

docs/api.md

@@ -0,0 +1,19 @@
+# API reference
+
+Auto-generated from the package docstrings.
+
+## Search engine
+
+::: mhc_tp.engine.search
+
+::: mhc_tp.engine.kernels
+
+## Reference data
+
+::: mhc_tp.refdata.fetch
+
+## Report
+
+::: mhc_tp.report.render
+
+::: mhc_tp.naming