Skip to content

Commit a4e98e4

Browse files
author
Tapan Chugh
committed
Set up GitHub Pages documentation deployment with Python 3.13.5 support
1 parent d11b9eb commit a4e98e4

File tree

3 files changed

+331
-217
lines changed

3 files changed

+331
-217
lines changed

.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+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v4
24+
with:
25+
submodules: recursive
26+
fetch-depth: 0
27+
28+
- name: Set up Python 3.13.5
29+
uses: actions/setup-python@v5
30+
with:
31+
python-version: '3.13.5'
32+
33+
- name: Install uv
34+
uses: astral-sh/setup-uv@v3
35+
with:
36+
version: "latest"
37+
38+
- name: Create virtual environment
39+
run: uv venv
40+
41+
- name: Install dependencies
42+
run: |
43+
source .venv/bin/activate
44+
uv pip install -e .
45+
uv pip install -r docs/requirements.txt
46+
47+
- name: Build documentation
48+
run: |
49+
source .venv/bin/activate
50+
mkdocs build --verbose
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

mkdocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
site_name: WAGS Documentation
22
site_description: Web Agent Gateway System - Middleware orchestration for MCP servers
33
site_author: WAGS Team
4-
site_url: https://wags.dev
4+
site_url: https://chughtapan.github.io/wags/
55
repo_url: https://github.com/chughtapan/wags
6-
repo_name: wags
6+
repo_name: chughtapan/wags
7+
edit_uri: edit/main/docs/
78

89
theme:
910
name: material

0 commit comments

Comments
 (0)