Repository navigation
Commit 6b82ed6
committed
ci: build the docs site on pull requests
Nothing in CI built the MkDocs site, and the path filters had no entry
for docs/** or mkdocs.yml, so docs and docs-toolchain changes ran no
checks at all. A broken build only surfaced on Read the Docs after
merge, where the previous version keeps being served.
Add a `docs` path filter and a `docs-build` job that installs
docs/requirements.txt on Python 3.10 (matching .readthedocs.yaml) and
runs `mkdocs build --strict`, so warnings such as links to missing
pages fail the PR.
Note: `--strict` must not be combined with `-q`; with MkDocs 1.6 the
quiet flag stops warnings from being counted and the build passes.
Signed-off-by: mday-io <mdaytn@gmail.com>1 parent df30765 commit 6b82ed6
1 file changed
Lines changed: 32 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
22 | 23 | | |
23 | 24 | | |
24 | 25 | | |
| |||
44 | 45 | | |
45 | 46 | | |
46 | 47 | | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
47 | 52 | | |
48 | 53 | | |
49 | 54 | | |
| |||
71 | 76 | | |
72 | 77 | | |
73 | 78 | | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
74 | 106 | | |
75 | 107 | | |
76 | 108 | | |
| |||
0 commit comments