Merge main branch into 9-feature-pip-installable

Author: ArthurDanjou

.github/workflows/documentation.yml

@@ -0,0 +1,54 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6.0.2
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install dependencies
+        run: uv sync --group docs
+
+      - name: Build documentation
+        run: uv run sphinx-build -b html docs docs/_build/html
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v7.0.1
+        with:
+          path: docs/_build/html
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5.0.0

.gitignore

@@ -14,6 +14,14 @@
 !uv.lock
 !.pre-commit-config.yaml
 
+# Except documentation files
+docs/_build
+!*.rst
+!*.html
+!*.css
+!*.js
+!*.svg
+
 # Github 
 !.github/*
 !*.yml

.python-version

@@ -0,0 +1 @@
+>=3.10

docs/Makefile

@@ -0,0 +1,22 @@
+# Makefile for Krum documentation
+
+.PHONY: help html clean servedocs live watch
+
+help:
+	@echo "Available targets:"
+	@echo "  html       - Build HTML documentation"
+	@echo "  clean      - Remove generated files"
+	@echo "  servedocs  - Build and serve static documentation"
+	@echo "  watch      - Watch for changes and serve (auto-rebuild)"
+
+html:
+	uv run sphinx-build -b html . _build/html
+
+clean:
+	rm -rf _build
+
+servedocs:
+	uv run sphinx-build -b html . _build/html && uv run python -m http.server 8000 -d _build/html
+
+watch:
+	uv run sphinx-autobuild -b html . _build/html --port 8000 --host 127.0.0.1

docs/_static/byzantine_attack.svg

@@ -0,0 +1,19 @@
+/* Custom CSS for Krum documentation */
+
+:root {
+    --pst-color-brand-primary: #2c3e50;
+    --pst-color-brand-secondary: #3498db;
+}
+
+.bd-header {
+    background-color: #2c3e50;
+}
+
+/* Hide empty "On this page" TOC */
+.bd-toc .page-toc:empty {
+    display: none;
+}
+
+.bd-toc .page-toc + .sidebar-secondary-item {
+    display: none;
+}

docs/_static/custom.css

@@ -0,0 +1,6 @@
+document.addEventListener("DOMContentLoaded", function () {
+  document.querySelectorAll('.viewcode-link, .reference.external[href*="github.com"]').forEach(function (link) {
+    link.setAttribute("target", "_blank");
+    link.setAttribute("rel", "noopener noreferrer");
+  });
+});