Skip to content

Commit da3cf43

Browse files
authored
bpo-46016: GHA Doc job now also runs "make check" (GH-30009)
The GitHub Action documentation job now also runs "make check" to check the documentation.
1 parent c8749b5 commit da3cf43

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

.github/workflows/doc.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,15 @@ jobs:
3838
run: make -j4
3939
- name: 'Install build dependencies'
4040
run: make -C Doc/ PYTHON=../python venv
41-
- name: 'Build documentation'
42-
run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest html
41+
# Run "check doctest html" as 3 steps to get a more readable output
42+
# in the web UI
43+
- name: 'Check documentation'
44+
run: make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" check
45+
# Use "xvfb-run" since some doctest tests open GUI windows
46+
- name: 'Run documentation doctest'
47+
run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest
48+
- name: 'Build HTML documentation'
49+
run: make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" html
4350
- name: 'Upload'
4451
uses: actions/[email protected]
4552
with:

0 commit comments

Comments
 (0)