Skip to content

Commit 01666b5

Browse files
committed
feat: add docs action
1 parent a7c8209 commit 01666b5

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

.github/workflows/release-docs.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Publish Docs
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v[0-9]+.[0-9]+.[0-9]+'
7+
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
deploy:
21+
environment:
22+
name: github-pages
23+
url: ${{ steps.deployment.outputs.page_url }}
24+
25+
runs-on: ubuntu-24.04
26+
27+
steps:
28+
- uses: actions/checkout@v4
29+
30+
- name: Setup venv
31+
run: |
32+
python -m venv .venv
33+
. .venv/bin/activate
34+
python -m pip install -r docs/doc-requirements.txt
35+
36+
- name: Run Sphinx
37+
run: |
38+
. .venv/bin/activate
39+
python -m sphinx -an docs docs/_build
40+
41+
- name: Setup pages
42+
uses: actions/configure-pages@v5
43+
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: 'docs/_build'
48+
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)