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.
python · Dec 9, 2021 · da3cf43 · da3cf43
1 parent c8749b5
commit da3cf43
Showing 1 changed file with 9 additions and 2 deletions.
diff --git 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: