summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2021-12-09 23:02:20 (GMT)
committerGitHub <noreply@github.com>2021-12-09 23:02:20 (GMT)
commitda3cf4304f6dd530533bbd2c0913b674cd803744 (patch)
tree62c84daa9717e03b7d63fa913293db2cb59f0baf
parentc8749b578324ad4089c8d014d9136bc42b065343 (diff)
downloadcpython-da3cf4304f6dd530533bbd2c0913b674cd803744.zip
cpython-da3cf4304f6dd530533bbd2c0913b674cd803744.tar.gz
cpython-da3cf4304f6dd530533bbd2c0913b674cd803744.tar.bz2
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.
-rw-r--r--.github/workflows/doc.yml11
1 files changed, 9 insertions, 2 deletions
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
index 755a4d5..ed44409 100644
--- a/.github/workflows/doc.yml
+++ b/.github/workflows/doc.yml
@@ -38,8 +38,15 @@ jobs:
run: make -j4
- name: 'Install build dependencies'
run: make -C Doc/ PYTHON=../python venv
- - name: 'Build documentation'
- run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest html
+ # Run "check doctest html" as 3 steps to get a more readable output
+ # in the web UI
+ - name: 'Check documentation'
+ run: make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" check
+ # Use "xvfb-run" since some doctest tests open GUI windows
+ - name: 'Run documentation doctest'
+ run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest
+ - name: 'Build HTML documentation'
+ run: make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" html
- name: 'Upload'
uses: actions/upload-artifact@v2.2.4
with: