Debian Codegraph @

.github/workflows/docs.yml

raw
1 name: Docs
2 on:
3 pull_request:
4 branches:
5 - main
6 push:
7 branches:
8 - main
9
10 jobs:
11 sphinx:
12 runs-on: ubuntu-latest
13 name: "Sphinx"
14 defaults:
15 run:
16 working-directory: docs
17
18 steps:
19 - name: Install system dependencies
20 run: >-
21 sudo apt-get install -y
22 python3-enchant
23 aspell-en
24 hunspell-en-us
25 working-directory: .
26
27 - uses: actions/checkout@v3
28 - uses: actions/setup-python@v4
29 with:
30 python-version: "3.10"
31
32 - name: Install dependencies
33 run: pip install -e .[docs]
34 working-directory: .
35
36 - run: sphinx-build -W -b linkcheck -d _build/doctrees . _build/linkcheck
37 - run: sphinx-build -W -b spelling -d _build/doctrees . _build/spelling
38 - run: sphinx-build -W -b html -d _build/doctrees . _build/html