-
Notifications
You must be signed in to change notification settings - Fork 15
52 lines (42 loc) · 1.13 KB
/
build_documentation.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
---
name: Build documentation
# Run workflow on pushes to matching branches
on: # yamllint disable-line rule:truthy
push:
branches: [develop, latest]
pull_request:
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.12
- name: Install hatch
run: pip install hatch
- name: Build documentation
run: hatch run docs:build
check_links:
name: Check links
runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.12
- name: Install hatch
run: pip install hatch
- name: Build documentation
run: hatch run docs:build
- name: Link Checker
uses: lycheeverse/lychee-action@v2.1.0
with:
args: --config='./.lychee.toml' --no-progress './docs/build/html/**/*.html'
fail: true # fail on broken links