Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-93735: Split Docs CI to speed-up the build #93736

Merged
merged 4 commits into from
Jun 15, 2022
Merged

gh-93735: Split Docs CI to speed-up the build #93736

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
83f05a8
Speed-up docs CI
AA-Turner May 17, 2022
e6fa8ec
Bump actions; grammar; both per Hugo
AA-Turner Jun 11, 2022
15ca649
Explicit python version
AA-Turner Jun 11, 2022
e0cffa9
Ezio's comments
AA-Turner Jun 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 34 additions & 12 deletions .github/workflows/doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ on:
paths:
- 'Doc/**'
- 'Misc/**'
- '.github/workflows/doc.yml'

jobs:
build_doc:
Expand All @@ -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
ezio-melotti marked this conversation as resolved.
Show resolved Hide resolved
- name: Register Sphinx problem matcher
run: echo "::add-matcher::.github/problem-matchers/sphinx.json"
ezio-melotti marked this conversation as resolved.
Show resolved Hide resolved
- 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'
Expand All @@ -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