Skip to content

Commit 8099593

Browse files
committed
CI: build docs and check for broken links
1 parent a06e2e8 commit 8099593

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

.github/workflows/main.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,24 @@ jobs:
4646
- name: Run tests
4747
run: |
4848
python -m pytest
49+
50+
docs:
51+
runs-on: ubuntu-latest
52+
steps:
53+
- name: Set up Python
54+
uses: actions/setup-python@v1
55+
with:
56+
python-version: 3.8
57+
- name: Double-check Python version
58+
run: |
59+
python --version
60+
- uses: actions/checkout@v2
61+
- name: Install doc dependencies
62+
run: |
63+
python -m pip install -r doc/requirements.txt
64+
- name: Create HTML docs
65+
run: |
66+
python -m sphinx doc _build/html -d _doctrees -W -b html
67+
- name: Check for broken links
68+
run: |
69+
python -m sphinx doc _build/linkcheck -d _doctrees -W -b linkcheck

0 commit comments

Comments
 (0)