]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-46016: GHA Doc job now also runs "make check" (GH-30009)
authorVictor Stinner <vstinner@python.org>
Thu, 9 Dec 2021 23:02:20 +0000 (00:02 +0100)
committerGitHub <noreply@github.com>
Thu, 9 Dec 2021 23:02:20 +0000 (00:02 +0100)
The GitHub Action documentation job now also runs "make check" to
check the documentation.

.github/workflows/doc.yml

index 755a4d5e173ee31fa66b0653b04fbc80f1c5f466..ed44409d118a231b51333d357bb11692ede428ae 100644 (file)
@@ -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: