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
|
name: docs
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
docs:
runs-on: macos-latest # for the screenshots
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: "3.x"
- run: |
python -m pip install --upgrade pip
python -m pip install -e .[docs]
- name: Deploy docs to GitHub Pages
if: github.event_name == 'push'
run: mkdocs gh-deploy --strict --force
- name: Test that docs build without error
if: github.event_name == 'pull_request'
run: mkdocs build --strict
|
