mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-03-25 00:07:41 +01:00
e1e7b621f1
Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
48 lines
1.6 KiB
YAML
48 lines
1.6 KiB
YAML
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@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
|
|
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
|