-
Notifications
You must be signed in to change notification settings - Fork 27
38 lines (34 loc) · 1.28 KB
/
ci.yml
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: colcon.readthedocs.org
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: 3.8
- name: Install dependencies
run: |
sudo apt update && sudo apt install -y enchant graphviz
python -m pip install --upgrade setuptools
python -m pip install --upgrade doc8 pyenchant sphinx-rtd-theme sphinxcontrib-spelling
- name: Check spelling
# show list of misspelled words
run: |
mkdir _build
make spelling
if [[ -s "_build/spelling/index.spelling" ]]; then cat "_build/spelling/index.spelling"; fi
- name: Build documentation
run: |
make html
- name: Lint generated documentation
run: |
doc8 --max-line-length 999 index.rst developer/ migration/ user/ -v
- name: Warnings and spelling errors fail the build
run: |
if [[ -s "_build/warnings_and_errors.log" ]]; then cat "_build/warnings_and_errors.log"; fi
if [[ -s "_build/spelling/index.spelling" ]]; then cat "_build/spelling/index.spelling"; fi
if [[ -s "_build/warnings_and_errors.log" ]]; then false; fi
if [[ -s "_build/spelling/index.spelling" ]]; then false; fi