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
name: Docs
on:
push:
branches:
paths:
- docs/**
- mkdocs.yml
- overrides/**
- examples/**
# the testing and conformance guides embed their snippets from these test files
- tests/doc_*.rs
- tests/conformance_self.rs
- scripts/lint_doc_fences.py
- .github/workflows/docs.yml
pull_request:
branches:
paths: *docs-paths
workflow_dispatch:
permissions:
contents: read
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
name: Build site
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install docs toolchain
run: pip install -r docs/requirements.txt
- name: Lint doc code fences
run: python3 scripts/lint_doc_fences.py
- name: Build site (strict)
run: mkdocs build --strict