Skip to content

Commit d45b5a0

Browse files
committed
Test Sphinx doc generation.
Need to detect issues early so that docs don't break on main.
1 parent 01c9bb6 commit d45b5a0

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

.github/workflows/python-package.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,31 @@ jobs:
163163
path: dist/*.whl
164164
retention-days: 7
165165

166+
test-docs:
167+
needs: [black, isort, mypy]
168+
runs-on: ubuntu-latest
169+
steps:
170+
- name: Install APT dependencies
171+
run: |
172+
sudo apt-get update
173+
sudo apt-get install libsdl2-dev
174+
- uses: actions/checkout@v3
175+
with:
176+
fetch-depth: ${{ env.git-depth }}
177+
- name: Checkout submodules
178+
run: git submodule update --init --recursive --depth 1
179+
- name: Install Python dependencies
180+
run: |
181+
python -m pip install --upgrade pip
182+
pip install -r docs/requirements.txt
183+
- name: Install package
184+
run: pip install -e .
185+
env:
186+
TDL_BUILD: DEBUG
187+
- name: Test doc generation
188+
working-directory: docs
189+
run: python -m sphinx -T -E -W --keep-going . _build/html
190+
166191
isolated: # Test installing the package from source.
167192
needs: [black, isort, mypy, sdist]
168193
runs-on: ${{ matrix.os }}

0 commit comments

Comments
 (0)