[Python-checkins] bpo-46016: GHA Doc job now also runs "make check" (GH-30009)
vstinner
webhook-mailer at python.org
Thu Dec 9 18:02:31 EST 2021
https://github.com/python/cpython/commit/da3cf4304f6dd530533bbd2c0913b674cd803744
commit: da3cf4304f6dd530533bbd2c0913b674cd803744
branch: main
author: Victor Stinner <vstinner at python.org>
committer: vstinner <vstinner at python.org>
date: 2021-12-10T00:02:20+01:00
summary:
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.
files:
M .github/workflows/doc.yml
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
index 755a4d5e173ee..ed44409d118a2 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 at v2.2.4
with:
More information about the Python-checkins
mailing list