Skip to content

Commit 46997c4

Browse files
add documentation workflow
1 parent 68d8538 commit 46997c4

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Documentation
3+
4+
on:
5+
release:
6+
types:
7+
- published
8+
workflow_dispatch: { }
9+
10+
jobs:
11+
build:
12+
name: Build documentation
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v5
16+
- uses: ./.github/actions/preparation
17+
- name: Build API documentation
18+
working-directory: docs/
19+
run: uv run sphinx-apidoc -o source/api ../src/tasktronaut
20+
- name: Build documentation
21+
working-directory: docs/
22+
run: uv run make html
23+
- name: Upload documentation files
24+
uses: actions/upload-artifact@v5
25+
working-directory: docs/
26+
with:
27+
name: documentation
28+
path: build/
29+
30+
publish:
31+
name: Publish documentation
32+
runs-on: ubuntu-latest
33+
needs:
34+
- build
35+
environment:
36+
name: github-pages
37+
url: ${{ steps.deployment.outputs.page_url }}
38+
permissions:
39+
contents: read
40+
pages: write
41+
id-token: write
42+
steps:
43+
- uses: actions/checkout@v5
44+
- uses: ./.github/actions/preparation
45+
- name: Retrieve documentation
46+
uses: actions/download-artifact@v5
47+
with:
48+
name: documentation
49+
path: docs/build/
50+
- name: Upload artifact
51+
uses: actions/upload-pages-artifact@v4
52+
with:
53+
path: docs/build/
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)