Skip to content

Commit f4e0c14

Browse files
authored
feat: add MkDocs documentation and config module (#964)
- Set up MkDocs Material for docs.openadapt.ai - Add unified config module with pydantic-settings - Add example scripts for capture-train-eval and demo-retrieval workflows - Add GitHub Actions workflow for automatic docs deployment
1 parent b9f7b83 commit f4e0c14

20 files changed

Lines changed: 3228 additions & 0 deletions

.github/workflows/docs.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
- '.github/workflows/docs.yml'
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
concurrency:
19+
group: "pages"
20+
cancel-in-progress: false
21+
22+
jobs:
23+
build:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
with:
29+
fetch-depth: 0
30+
31+
- name: Setup Python
32+
uses: actions/setup-python@v5
33+
with:
34+
python-version: '3.12'
35+
36+
- name: Cache pip
37+
uses: actions/cache@v4
38+
with:
39+
path: ~/.cache/pip
40+
key: ${{ runner.os }}-pip-mkdocs-${{ hashFiles('mkdocs.yml') }}
41+
restore-keys: |
42+
${{ runner.os }}-pip-mkdocs-
43+
44+
- name: Install dependencies
45+
run: |
46+
pip install --upgrade pip
47+
pip install mkdocs-material mkdocs-minify-plugin
48+
49+
- name: Build documentation
50+
run: mkdocs build --strict
51+
52+
- name: Setup Pages
53+
uses: actions/configure-pages@v4
54+
55+
- name: Upload artifact
56+
uses: actions/upload-pages-artifact@v3
57+
with:
58+
path: site
59+
60+
deploy:
61+
environment:
62+
name: github-pages
63+
url: ${{ steps.deployment.outputs.page_url }}
64+
runs-on: ubuntu-latest
65+
needs: build
66+
steps:
67+
- name: Deploy to GitHub Pages
68+
id: deployment
69+
uses: actions/deploy-pages@v4

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.openadapt.ai

0 commit comments

Comments
 (0)