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
|
name: Docs
on:
push:
pull_request:
branches: [ "main" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
permissions:
contents: read
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install docs dependencies
shell: bash
run: |
python -m pip install --upgrade pip
python -m pip install sphinx sphinxcontrib-spelling
python -m pip install .[test]
if [ -f requirements-docs.txt ]; then pip install -r requirements-docs.txt; fi
if [ -f docs/requirements-docs.txt ]; then pip install -r docs/requirements-docs.txt; fi
- name: Build docs
run: |
mkdir -p _static
python3 -m sphinx -W -b html . _build/html
working-directory: docs
env:
PYTHONPATH: ..
- name: Check links
run: |
mkdir -p _static
python3 -m sphinx -W -b linkcheck . _build/linkcheck
working-directory: docs
env:
PYTHONPATH: ..
- name: Doctest
run: |
mkdir -p _static
python3 -m sphinx -W -b doctest . _build/doctest
working-directory: docs
env:
PYTHONPATH: ..
- name: Spellcheck
run: |
mkdir -p _static
python3 -m sphinx -W -b spelling . _build/spelling
working-directory: docs
env:
PYTHONPATH: ..
|
