mirror of https://github.com/python/cpython
98 lines
3.2 KiB
YAML
98 lines
3.2 KiB
YAML
name: Docs
|
|
|
|
on:
|
|
workflow_call:
|
|
workflow_dispatch:
|
|
|
|
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
|
|
timeout-minutes: 60
|
|
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
|
|
|
|
# To annotate PRs with Sphinx nitpicks (missing references)
|
|
- name: 'Get list of changed files'
|
|
if: github.event_name == 'pull_request'
|
|
id: changed_files
|
|
uses: Ana06/get-changed-files@v2.2.0
|
|
with:
|
|
filter: "Doc/**"
|
|
format: csv # works for paths with spaces
|
|
- name: 'Build HTML documentation'
|
|
continue-on-error: true
|
|
run: |
|
|
set -Eeuo pipefail
|
|
# Build docs with the '-n' (nit-picky) option; write warnings to file
|
|
make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n -W --keep-going -w sphinx-warnings.txt" html
|
|
- name: 'Check warnings'
|
|
if: github.event_name == 'pull_request'
|
|
run: |
|
|
python Doc/tools/check-warnings.py \
|
|
--check-and-annotate '${{ steps.changed_files.outputs.added_modified }}' \
|
|
--fail-if-regression \
|
|
--fail-if-improved
|
|
|
|
# This build doesn't use problem matchers or check annotations
|
|
build_doc_oldest_supported_sphinx:
|
|
name: 'Docs (Oldest Sphinx)'
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 60
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- name: 'Set up Python'
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: '3.11' # known to work with Sphinx 3.2
|
|
cache: 'pip'
|
|
cache-dependency-path: 'Doc/requirements-oldest-sphinx.txt'
|
|
- name: 'Install build dependencies'
|
|
run: make -C Doc/ venv REQUIREMENTS="requirements-oldest-sphinx.txt"
|
|
- name: 'Build HTML documentation'
|
|
run: make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html
|
|
|
|
# Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release
|
|
doctest:
|
|
name: 'Doctest'
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 60
|
|
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
|