Skip to content

Commit 4f2bb9c

Browse files
committed
DOCS: refactor docs to use mkdocs
1 parent 0fab865 commit 4f2bb9c

33 files changed

Lines changed: 1308 additions & 1372 deletions

.github/workflows/docs.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
paths:
7+
- ".github/workflows/docs.yml"
8+
- "docs/**"
9+
- "mkdocs.yml"
10+
- "pyproject.toml"
11+
- "packages/eaa-core/pyproject.toml"
12+
- "uv.lock"
13+
workflow_dispatch:
14+
15+
permissions:
16+
contents: read
17+
pages: write
18+
id-token: write
19+
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
build:
26+
runs-on: ubuntu-latest
27+
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v4
31+
32+
- name: Set up Python
33+
uses: actions/setup-python@v5
34+
with:
35+
python-version: "3.11"
36+
37+
- name: Install uv
38+
uses: astral-sh/setup-uv@v5
39+
40+
- name: Build documentation
41+
run: uv run --frozen --extra docs mkdocs build --strict
42+
43+
- name: Configure Pages
44+
uses: actions/configure-pages@v5
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: site
50+
51+
deploy:
52+
needs: build
53+
runs-on: ubuntu-latest
54+
environment:
55+
name: github-pages
56+
url: ${{ steps.deployment.outputs.page_url }}
57+
58+
steps:
59+
- name: Deploy to GitHub Pages
60+
id: deployment
61+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ skill_factory/
2121
AGENTS.md
2222
CLAUDE.md
2323
docs/_build/
24+
site/
2425

2526
# Images
2627
**/*.png

.readthedocs.yaml

Lines changed: 0 additions & 13 deletions
This file was deleted.

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -265,14 +265,12 @@ python -m eaa_core.cli install-skills --destination ~/.eaa_skills
265265

266266
## Documentation
267267

268-
Sphinx documentation lives under `docs/` and is configured for Read the Docs.
269-
Build it locally with:
268+
Documentation lives under `docs/` and is built with Material for MkDocs. Build
269+
it locally with:
270270

271271
```bash
272-
uv sync --extra docs
273-
source .venv/bin/activate
274-
cd docs
275-
make html
272+
uv run --extra docs mkdocs build --strict
276273
```
277274

278-
The generated site will be in `docs/_build/html/`.
275+
The generated site will be in `site/`. The GitHub Actions workflow in
276+
`.github/workflows/docs.yml` publishes it to `https://mdw771.github.io/eaa/`.

docs/Makefile

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/conf.py

Lines changed: 0 additions & 44 deletions
This file was deleted.

0 commit comments

Comments
 (0)