Skip to content

Commit db55754

Browse files
committed
feat: Workflow to push static Python documentation
1 parent e53e851 commit db55754

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

.github/workflows/publish-doc.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy static manual to Pages
2+
3+
on:
4+
release:
5+
types: [created, published]
6+
push:
7+
branches: ["main"]
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+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
29+
- uses: prefix-dev/setup-pixi@v0.8.8
30+
with:
31+
pixi-version: v0.48.0
32+
cache: true
33+
frozen: true
34+
35+
- uses: Swatinem/rust-cache@v2
36+
with:
37+
save-if: ${{ github.ref == 'refs/heads/main' }}
38+
39+
- name: Build HTML
40+
# Turn warning into errors
41+
run: SPHINXOPTS="-W --keep-going -n" pixi run -e docs python-docs
42+
43+
- name: Setup Pages
44+
uses: actions/configure-pages@v5
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: 'docs/_build/html'
50+
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v4
54+

0 commit comments

Comments
 (0)