-
Notifications
You must be signed in to change notification settings - Fork 122
57 lines (45 loc) · 1.49 KB
/
doc-tests.yml
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
53
54
55
56
57
name: test-docs
run-name: Documentation tests
on:
pull_request:
push:
branches: [main]
permissions:
contents: read
jobs:
doc-test:
name: Sphinx Documentation Tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.x'
cache: 'pip'
- name: Set PIPX_HOME
run: echo "PIPX_HOME=${{ runner.home }}/.pipx" >> $GITHUB_ENV
- name: Cache pipx environments
uses: actions/cache@v3
with:
path: ${{ runner.home }}/.pipx
# pipx is creating a cachedir.tag with unique signature
key: ${{ runner.os }}-pipx-${{ hashFiles(.pipx/.cache/CACHEDIR.TAG) }}
restore-keys: |
${{ runner.os }}-pipx-
- name: Make sure latest hatch is installed
run: pipx upgrade hatch || pipx install hatch
- name: Cache Hatch environments
uses: actions/cache@v3
with:
path: .hatch_envs
# hatch envs are described in pyproject.toml
key: ${{ runner.os }}-hatch-envs-${{ hashFiles('pyproject.toml') }}
restore-keys: |
${{ runner.os }}-hatch-envs-
- name: Set HATCH_ENV_TYPE_VIRTUAL_PATH
run: echo "HATCH_ENV_TYPE_VIRTUAL_PATH=$(pwd)/.hatch_envs" >> $GITHUB_ENV
- name: Run sphinx html builder
# -W = warnings as error
run: hatch run docs:html -W
- name: Run sphinx linkcheck
run: hatch run docs:linkcheck