From 1a59b9bff10df141f6b33f15799a5716c07e5df2 Mon Sep 17 00:00:00 2001 From: Ammar Askar Date: Sat, 15 Feb 2020 17:23:28 -0800 Subject: [PATCH 1/3] Use sphinx-action for better doc warnings --- .github/workflows/doc.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 5bba8e690655fa..ca3ba518132853 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -33,6 +33,10 @@ jobs: run: make -C Doc/ PYTHON=../python venv - name: 'Build documentation' run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W -j4" doctest suspicious html + - name: 'Build documentation with warnings' + uses: ammaraskar/sphinx-action@master + with: + docs-folder: "Doc/" - name: 'Upload' uses: actions/upload-artifact@v1 with: From 68752af77240a222c5203606201f12da7287ca7a Mon Sep 17 00:00:00 2001 From: Ammar Askar Date: Sat, 15 Feb 2020 17:24:45 -0800 Subject: [PATCH 2/3] Intentionally introduce a warning --- Doc/bugs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/bugs.rst b/Doc/bugs.rst index a17f04d26fa40b..a3ee425b9959fc 100644 --- a/Doc/bugs.rst +++ b/Doc/bugs.rst @@ -2,7 +2,7 @@ ***************** Dealing with Bugs -***************** +************** Python is a mature programming language which has established a reputation for stability. In order to maintain this reputation, the developers would like to From 49ae7ac4ae4163a7bf0e55d8639aee1d56e758fa Mon Sep 17 00:00:00 2001 From: Ammar Askar Date: Sat, 15 Feb 2020 17:32:19 -0800 Subject: [PATCH 3/3] Re-order build steps so we run first --- .github/workflows/doc.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index ca3ba518132853..85c2c15fd89806 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -31,12 +31,12 @@ jobs: run: make -s -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 -j4" doctest suspicious html - - name: 'Build documentation with warnings' + - name: 'Build documentation showing warnings' uses: ammaraskar/sphinx-action@master with: docs-folder: "Doc/" + - name: 'Build documentation' + run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W -j4" doctest suspicious html - name: 'Upload' uses: actions/upload-artifact@v1 with: