Deploy docs to gh pages

.github/mkdocs.yml

@@ -0,0 +1,75 @@
+site_name: Hyperbench Documentation
+site_description: Documentation for Hyperbench
+site_author: Hypernetwork Research Group
+site_url: https://hypernetwork-research-group.github.io/hyperbench
+
+repo_name: hypernetwork-research-group/hyperbench
+repo_url: https://github.com/hypernetwork-research-group/hyperbench
+
+docs_dir: ../docs
+theme:
+  name: material
+  palette:
+    - scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - navigation.expand
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.code.copy
+
+nav:
+  - Home: index.md
+  - Getting Started:
+      - Installation: getting-started/installation.md
+  - User Guide:
+      - Overview: user-guide/user.md
+  - API Reference:
+      - API: api/reference.md
+  - Dev: ref.md
+
+markdown_extensions:
+  - admonition
+  - codehilite
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.superfences
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.details
+  - pymdownx.tabbed:
+      alternate_style: true
+  - toc:
+      permalink: true
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [..]
+          options:
+            docstring_style: numpy
+            show_source: true
+            show_root_heading: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            members_order: source
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/hypernetwork-research-group/hyperbench

.github/workflows/docs.yaml

@@ -0,0 +1,33 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+      - docs
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.14"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install dependencies
+        run: |
+          uv venv
+          uv pip install -e .
+
+      - name: Deploy to GitHub Pages
+        run: |
+          uv run mkdocs gh-deploy -f .github/mkdocs.yml --force

docs/api/reference.md

@@ -0,0 +1,53 @@
+# API Reference
+
+Complete API documentation for all Hyperbench modules.
+
+## Core Modules
+
+### Data Module
+
+::: hyperbench.data.dataset
+    options:
+      show_root_heading: true
+      show_source: true
+      members_order: source
+      show_submodules: true
+
+## Types Module
+
+### HData
+
+::: hyperbench.types.hdata
+    options:
+      show_root_heading: true
+      show_source: true
+
+### Hypergraph
+
+::: hyperbench.types.hypergraph
+    options:
+      show_root_heading: true
+      show_source: true
+
+## Utils Module
+
+### Data Utils
+
+::: hyperbench.utils.data_utils
+    options:
+      show_root_heading: true
+      show_source: true
+
+### HIF Utils
+
+::: hyperbench.utils.hif_utils
+    options:
+      show_root_heading: true
+      show_source: true
+
+## Data Loader
+
+::: hyperbench.data.loader
+    options:
+      show_root_heading: true
+      show_source: true

docs/getting-started/installation.md

@@ -0,0 +1,3 @@
+# Installation
+
+## Prerequisites

docs/index.md

@@ -0,0 +1,13 @@
+# Hyperbench Documentation
+
+Welcome to Hyperbench - A comprehensive benchmarking framework for hypergraph neural networks.
+
+## Quick Links
+
+- [Installation Guide](getting-started/installation.md)
+- [User Guide](user-guide/user.md)
+- [API Reference](api/reference.md)
+
+## Overview
+
+Hyperbench provides tools for working with hypergraph data in machine learning contexts. It supports loading datasets in HIF format, transforming them into PyTorch tensors, and preparing them for training hypergraph neural networks.

docs/user-guide/user.md

@@ -0,0 +1,5 @@
+# User Guide
+
+## Overview
+
+Hyperbench is designed to simplify working with hypergraph data in machine learning contexts.

pyproject.toml

@@ -15,6 +15,9 @@ dependencies = [
 
 [dependency-groups]
 dev = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings[python]>=0.24.0",
     "pre-commit>=4.5.1",
     "pytest>=8.4.2",
     "pytest-cov>=7.0.0",