Repository navigation
67 lines (54 loc) · 1.75 KB
/
Copy pathdocs.yml
File metadata and controls
67 lines (54 loc) · 1.75 KB
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
61
62
63
64
65
66
67
name: Documentation Build and Check
on:
pull_request:
branches:
- develop
push:
branches:
- develop
jobs:
linkcheck:
name: Check Links
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
- name: Set up Python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r installer/requirements-docs.txt
- name: Run documentation checks
run: python3 tools/docs_check.py
mkdocs-build:
name: Build MkDocs Site
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
- name: Set up Python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r installer/requirements-docs.txt
- name: Build MkDocs site
run: |
# Check if mkdocs.yml exists
if [ ! -f mkdocs.yml ]; then
echo "Error: mkdocs.yml not found"
exit 1
fi
# Build the site (will fail if strict mode is enabled)
mkdocs build --strict
- name: Upload site artifact
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
with:
name: mkdocs-site
path: site/
retention-days: 7