From 312c4b426170fff9ed2f509119a9b05294af933c Mon Sep 17 00:00:00 2001 From: Victor Stinner Date: Thu, 9 Dec 2021 17:25:49 +0100 Subject: [PATCH] bpo-46016: GHA Doc job now also runs "make check" The GitHub Action documentation job now also runs "make check" to check the documentation. --- .github/workflows/doc.yml | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 755a4d5e173ee3..ed44409d118a23 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: