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
|
name: Build docs
on: [push, pull_request]
permissions:
contents: read
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: 3.x
cache: pip
cache-dependency-path: |
docs/requirements.txt
pyproject.toml
- name: Install uv
uses: astral-sh/setup-uv@v7
- name: Install Graphviz
run: |
sudo apt-get update
sudo apt-get install graphviz
- name: Install Python dependencies
run: |
uv pip install --system setuptools coverage rstvalidator
uv pip install --system -r docs/requirements.txt
- name: Build docs
run: |
python -m rstvalidator long_description.rst
python tools/fixup_whats_new_pr.py
make -C docs/ html SPHINXOPTS="-W" \
PYTHON="coverage run -a" \
SPHINXBUILD="coverage run -a -m sphinx.cmd.build"
- name: Generate coverage xml
run: |
coverage combine `find . -name .coverage\*` && coverage xml
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v5
with:
name: Docs
|
