[pull] master from python-telegram-bot:master #70
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Test Documentation Build | |
on: | |
pull_request: | |
paths: | |
- telegram/** | |
- docs/** | |
push: | |
branches: | |
- master | |
jobs: | |
test-sphinx-build: | |
name: test-sphinx-build | |
runs-on: ${{matrix.os}} | |
strategy: | |
matrix: | |
python-version: ['3.10'] | |
os: [ubuntu-latest] | |
fail-fast: False | |
steps: | |
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
with: | |
persist-credentials: false | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
with: | |
python-version: ${{ matrix.python-version }} | |
cache: 'pip' | |
cache-dependency-path: '**/requirements*.txt' | |
- name: Install dependencies | |
run: | | |
python -W ignore -m pip install --upgrade pip | |
python -W ignore -m pip install -r requirements-dev-all.txt | |
- name: Test autogeneration of admonitions | |
run: pytest -v --tb=short tests/docs/admonition_inserter.py | |
- name: Build docs | |
run: sphinx-build docs/source docs/build/html -W --keep-going -j auto | |
- name: Upload docs | |
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 | |
with: | |
name: HTML Docs | |
retention-days: 7 | |
path: | | |
# Exclude the .doctrees folder and .buildinfo file from the artifact | |
# since they are not needed and add to the size | |
docs/build/html/* | |
!docs/build/html/.doctrees | |
!docs/build/html/.buildinfo |