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
|
name: Docs
on:
pull_request:
branches:
- main
push:
branches:
- main
jobs:
sphinx:
runs-on: ubuntu-latest
name: "Sphinx"
defaults:
run:
working-directory: docs
steps:
- name: Install system dependencies
run: >-
sudo apt-get install -y
python3-enchant
aspell-en
hunspell-en-us
working-directory: .
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install dependencies
run: pip install -e .[docs]
working-directory: .
- run: sphinx-build -W -b linkcheck -d _build/doctrees . _build/linkcheck
- run: sphinx-build -W -b spelling -d _build/doctrees . _build/spelling
- run: sphinx-build -W -b html -d _build/doctrees . _build/html
|