-
Notifications
You must be signed in to change notification settings - Fork 472
47 lines (44 loc) · 1.01 KB
/
docs.yaml
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
name: Documentation
on:
push:
branches:
- master
pull_request:
paths:
- mkdocs.yml
- docs/
- README.md
- LICENSE
- extras/**/README.md
- .github/CONTRIBUTING.md
workflow_dispatch:
jobs:
lint:
name: Lint Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: DavidAnson/markdownlint-cli2-action@v13
with:
globs: |
docs/**/*.md
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: "3.11"
cache: 'pip'
- name: Install dependencies
run: |
pip install --upgrade pip
pip install --requirement docs/requirements.pip
- name: Build documentation
run: mkdocs build
# To remove if not using github pages
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: site