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
|
# .github/workflows/build-docs.yml
# See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
name: Build Documentation
on:
pull_request:
paths:
- "docs/**"
- "src/**/*.py"
- "noxfile.py"
- "pyproject.toml"
- ".github/workflows/build-docs.yml"
- ".ruff.toml" # Affects docstrings via linting
- "pyrightconfig.json" # Affects type hints in docs
push:
branches:
- main
- master
paths:
- "docs/**"
- "src/**/*.py"
- "noxfile.py"
- "pyproject.toml"
- ".github/workflows/build-docs.yml"
workflow_dispatch:
jobs:
build-docs:
name: Run Documentation Build Check
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v6
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version-file: ".github/workflows/.python-version"
- name: Build documentation
run: uvx nox -s build-docs
- name: Upload documentation (HTML) Artifact
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/_build/html/
|
