Skip to content

Commit 32b0d87

Browse files
jensensclaude
andcommitted
Add Sphinx documentation with Diataxis structure and GitHub Pages deployment
Addresses community feedback (gforcada) requesting contributor docs for adding migration rules and a maintenance strategy overview. - 21 pages: tutorials, how-to guides, reference, explanation - MyST Markdown, shibuya theme, MXMAKE build system - GitHub Actions workflow for auto-deploy to Pages - README slimmed down, links to full docs Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent e63b3c5 commit 32b0d87

28 files changed

+1705
-281
lines changed

.github/workflows/docs.yaml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Documentation
3+
4+
on:
5+
push:
6+
branches: [main]
7+
paths:
8+
- "docs/**"
9+
- ".github/workflows/docs.yaml"
10+
workflow_dispatch:
11+
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
concurrency:
18+
group: pages
19+
cancel-in-progress: true
20+
21+
jobs:
22+
build:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- uses: actions/checkout@v4
26+
27+
- uses: actions/setup-python@v5
28+
with:
29+
python-version: "3.13"
30+
31+
- uses: astral-sh/setup-uv@v4
32+
33+
- name: Install docs dependencies
34+
working-directory: docs
35+
run: |
36+
uv venv .venv
37+
uv pip install sphinx sphinx-autobuild \
38+
myst_parser sphinxcontrib.mermaid shibuya \
39+
sphinx-design sphinx-copybutton
40+
41+
- name: Build documentation
42+
working-directory: docs
43+
run: .venv/bin/sphinx-build sources html
44+
45+
- uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: docs/html
48+
49+
deploy:
50+
needs: build
51+
runs-on: ubuntu-latest
52+
environment:
53+
name: github-pages
54+
url: "${{ steps.deployment.outputs.page_url }}"
55+
steps:
56+
- name: Deploy to GitHub Pages
57+
id: deployment
58+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)