-
Notifications
You must be signed in to change notification settings - Fork 4
41 lines (38 loc) · 994 Bytes
/
docs.yml
File metadata and controls
41 lines (38 loc) · 994 Bytes
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
name: Docs
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
build:
name: Test build docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: pip
- name: install requirements
run: |
python -im pip install --upgrade pip
python -im pip install .[docs]
- name: Build docs
run: |
python -m sphinx -W -n -b html -a docs docs/_build
linkcheck:
name: Linkcheck
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: "pip"
- name: install requirements
run: |
python -im pip install --upgrade pip
python -im pip install .[docs]
- name: Linkcheck docs
run: python -m sphinx -b linkcheck -a docs docs/_build/linkcheck