mirror of https://github.com/python/cpython.git
gh-93735: Split Docs CI to speed-up the build (GH-93736)
(cherry picked from commit 4f26963526
)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
parent
73c8f3ff54
commit
7db66d8816
|
@ -23,6 +23,7 @@ on:
|
|||
paths:
|
||||
- 'Doc/**'
|
||||
- 'Misc/**'
|
||||
- '.github/workflows/doc.yml'
|
||||
|
||||
jobs:
|
||||
build_doc:
|
||||
|
@ -32,6 +33,38 @@ jobs:
|
|||
- uses: actions/checkout@v3
|
||||
- name: Register Sphinx problem matcher
|
||||
run: echo "::add-matcher::.github/problem-matchers/sphinx.json"
|
||||
- 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'
|
||||
run: make -C Doc/ venv
|
||||
- name: 'Check documentation'
|
||||
run: make -C Doc/ check
|
||||
- name: 'Build HTML documentation'
|
||||
run: make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-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 +73,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
|
||||
run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" doctest
|
||||
|
|
Loading…
Reference in New Issue