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
55
56
57
58
59
60
name: Docs
# Build the Material for MkDocs site and publish it to GitHub Pages.
#
# One-time setup: in the repository settings, set
# Settings -> Pages -> Build and deployment -> Source = "GitHub Actions".
# No `gh-pages` branch is used; the built site is uploaded as a Pages artifact
# and served directly from the deployment below.
on:
push:
branches:
paths:
- "docs/**"
- "mkdocs.yml"
- "CHANGELOG.md"
- "requirements-docs.txt"
- ".github/workflows/docs.yml"
workflow_dispatch:
# Minimal permissions for the GitHub Pages deployment.
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment; let an in-progress run finish.
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
name: Build site
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.x"
cache: pip
cache-dependency-path: requirements-docs.txt
- run: pip install -r requirements-docs.txt
# `--strict` fails the build on broken links or pages missing from the
# nav, so a regression never ships silently.
- run: mkdocs build --strict
- uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
name: Deploy to Pages
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4