mirror of https://github.com/python/cpython
86 lines
2.2 KiB
YAML
86 lines
2.2 KiB
YAML
name: Docs
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
#push:
|
|
# branches:
|
|
# - 'main'
|
|
# - '3.11'
|
|
# - '3.10'
|
|
# - '3.9'
|
|
# - '3.8'
|
|
# - '3.7'
|
|
# paths:
|
|
# - 'Doc/**'
|
|
pull_request:
|
|
branches:
|
|
- 'main'
|
|
- '3.11'
|
|
- '3.10'
|
|
- '3.9'
|
|
- '3.8'
|
|
- '3.7'
|
|
paths:
|
|
- 'Doc/**'
|
|
- 'Misc/**'
|
|
- '.github/workflows/doc.yml'
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
build_doc:
|
|
name: 'Docs'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- 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'
|
|
run: ./configure --with-pydebug
|
|
- name: 'Build CPython'
|
|
run: make -j4
|
|
- name: 'Install build dependencies'
|
|
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 SPHINXERRORHANDLING="-W --keep-going" doctest
|