Skip to content

Insert signature name for use with Sphinx Table of Contents (#959) #935

Insert signature name for use with Sphinx Table of Contents (#959)

Insert signature name for use with Sphinx Table of Contents (#959) #935

Workflow file for this run

name: Tests
on:
push:
paths:
- ".github/workflows/unit_tests.yml"
- "breathe/**"
- "tests/**"
pull_request:
paths:
- ".github/workflows/unit_tests.yml"
- "breathe/**"
- "tests/**"
permissions:
contents: read
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
env:
FORCE_COLOR: "1"
PYTHONDEVMODE: "1" # -X dev
PYTHONWARNDEFAULTENCODING: "1" # -X warn_default_encoding
jobs:
test:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version:
- '3.9'
- '3.10'
- '3.11'
- '3.12'
sphinx-version:
- '6.2'
- '7.0'
- '7.1'
- '7.2'
- '7.3'
- '7.4'
- '8.0'
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install .[test]
- name: Install Sphinx ${{ matrix.sphinx-version }}
run: python -m pip install --upgrade "Sphinx~=${{ matrix.sphinx-version }}.0"
- name: Test with pytest
run: python -m pytest -vv
env:
PYTHONWARNINGS: "error" # treat all warnings as errors
test-latest-sphinx:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python }}
uses: actions/setup-python@v5
with:
python-version: "3"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install .[test]
- name: Install Sphinx master
run: python -m pip install "Sphinx @ git+https://github.com/sphinx-doc/sphinx"
- name: Test with pytest
run: python -m pytest -vv