Skip to content

Commit a9e6a8b

Browse files
authored
Merge pull request #282 from KumarLabJax/task/add-docs-github-actions-definition
Add github pages deployment pipeline
2 parents 5ffb45f + d6ef04f commit a9e6a8b

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

.github/workflows/docs.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Documentation
2+
on:
3+
push:
4+
branches:
5+
- main
6+
permissions:
7+
contents: read
8+
pages: write
9+
id-token: write
10+
jobs:
11+
deploy:
12+
environment:
13+
name: github-pages
14+
url: ${{ steps.deployment.outputs.page_url }}
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v5
18+
- uses: actions/configure-pages@v5
19+
- uses: actions/setup-python@v5
20+
with:
21+
python-version: 3.13
22+
- name: Install uv
23+
uses: astral-sh/setup-uv@v3
24+
with:
25+
version: "latest"
26+
- name: Install dependencies with uv
27+
run: uv sync --only-group docs
28+
- run: uv run --only-group docs zensical build --clean
29+
- uses: actions/upload-pages-artifact@v4
30+
with:
31+
path: site
32+
- uses: actions/deploy-pages@v4
33+
id: deployment

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ tests/testing_notebook.ipynb
2424
docs/notes.txt
2525
docs/work_history.md
2626
docs/drafts/
27-
site/
27+
site/

0 commit comments

Comments
 (0)