Skip to content

Commit 8b61749

Browse files
committed
sphinx github workflow
1 parent 81056d0 commit 8b61749

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.github/workflows/sphinx.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: "Sphinx: Render docs"
2+
3+
on: push
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
permissions:
9+
contents: write
10+
steps:
11+
- uses: actions/checkout@v4
12+
with:
13+
persist-credentials: false
14+
- name: Install uv
15+
uses: astral-sh/setup-uv@v7
16+
with:
17+
version: '0.9.10'
18+
- name: Install dependencies
19+
run: uv sync --group docs
20+
- name: Build HTML
21+
uses: ammaraskar/sphinx-action@master
22+
with:
23+
docs_folder: docs/
24+
- name: Upload artifacts
25+
uses: actions/upload-artifact@v4
26+
with:
27+
name: html-docs
28+
path: docs/_build/html/
29+
- name: Deploy
30+
uses: peaceiris/actions-gh-pages@v4
31+
if: github.ref == 'refs/heads/main'
32+
with:
33+
github_token: ${{ secrets.GITHUB_TOKEN }}
34+
publish_dir: docs/build/html

0 commit comments

Comments
 (0)