From 83f05a810dd97166d6f5955c99e81fe0bfa54cad Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Tue, 17 May 2022 20:06:33 +0100 Subject: [PATCH 1/4] Speed-up docs CI --- .github/workflows/doc.yml | 43 +++++++++++++++++++++++++++++---------- 1 file changed, 32 insertions(+), 11 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 8c4a0348961266..084c26c73d3ac8 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -23,6 +23,7 @@ on: paths: - 'Doc/**' - 'Misc/**' + - '.github/workflows/doc.yml' jobs: build_doc: @@ -32,6 +33,37 @@ jobs: - uses: actions/checkout@v3 - name: Register Sphinx problem matcher run: echo "::add-matcher::.github/problem-matchers/sphinx.json" + - name: 'Setup Python' + uses: actions/setup-python@v3 + with: + cache: 'pip' + cache-dependency-path: 'Doc/requirements.txt' + - name: 'Install build dependencies' + run: make -C Doc/ venv + - name: 'Check documentation' + run: make -C Doc/ SPHINXOPTS="-q -W --keep-going" check + - name: 'Build HTML documentation' + run: make -C Doc/ SPHINXOPTS="-q -W --keep-going" html + - name: 'Upload' + uses: actions/upload-artifact@v3 + with: + name: doc-html + path: Doc/build/html + + # Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release + doctest: + name: 'Doctest' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Register Sphinx problem matcher + run: echo "::add-matcher::.github/problem-matchers/sphinx.json" + - uses: actions/cache@v3 + with: + path: ~/.cache/pip + key: ubuntu-doc-${{ hashFiles('Doc/requirements.txt') }} + restore-keys: | + ubuntu-doc- - name: 'Install Dependencies' run: sudo ./.github/workflows/posix-deps-apt.sh && sudo apt-get install wamerican - name: 'Configure CPython' @@ -40,17 +72,6 @@ jobs: run: make -j4 - name: 'Install build dependencies' run: make -C Doc/ PYTHON=../python venv - # 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" 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" doctest - - name: 'Build HTML documentation' - run: make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going" html - - name: 'Upload' - uses: actions/upload-artifact@v3 - with: - name: doc-html - path: Doc/build/html From e6fa8ec9f5bc3e8888f9c2f686f234b7d820e223 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 11 Jun 2022 23:19:40 +0100 Subject: [PATCH 2/4] Bump actions; grammar; both per Hugo --- .github/workflows/doc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 084c26c73d3ac8..ce2d60335201cb 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -33,8 +33,8 @@ jobs: - uses: actions/checkout@v3 - name: Register Sphinx problem matcher run: echo "::add-matcher::.github/problem-matchers/sphinx.json" - - name: 'Setup Python' - uses: actions/setup-python@v3 + - name: 'Set up Python' + uses: actions/setup-python@v4 with: cache: 'pip' cache-dependency-path: 'Doc/requirements.txt' From 15ca6490a770fe477a60644f80830c9673ca133d Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 11 Jun 2022 23:31:59 +0100 Subject: [PATCH 3/4] Explicit python version --- .github/workflows/doc.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index ce2d60335201cb..1405ab82ea5eca 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -36,6 +36,7 @@ jobs: - name: 'Set up Python' uses: actions/setup-python@v4 with: + python-version: '3' cache: 'pip' cache-dependency-path: 'Doc/requirements.txt' - name: 'Install build dependencies' From e0cffa97619397266648d32c09f73670aceb4441 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sun, 12 Jun 2022 09:36:16 +0100 Subject: [PATCH 4/4] Ezio's comments - Split to SPHINXOPTS and SPHINXERRORHANDLING - Remove SPHINXOPTS from make check --- .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 1405ab82ea5eca..73a6a50520e02d 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -42,9 +42,9 @@ jobs: - name: 'Install build dependencies' run: make -C Doc/ venv - name: 'Check documentation' - run: make -C Doc/ SPHINXOPTS="-q -W --keep-going" check + run: make -C Doc/ check - name: 'Build HTML documentation' - run: make -C Doc/ SPHINXOPTS="-q -W --keep-going" html + run: make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html - name: 'Upload' uses: actions/upload-artifact@v3 with: @@ -75,4 +75,4 @@ jobs: run: make -C Doc/ PYTHON=../python venv # 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" doctest + run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" doctest