small README update #194
Workflow file for this run
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: ci | |
on: [push] | |
jobs: | |
build: | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
os: [ubuntu-latest, windows-latest] | |
python-version: ['3.9', '3.10', '3.11', '3.12'] | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install package and dependencies | |
run: | | |
python3 -m pip install --upgrade pip setuptools wheel | |
pip install . | |
- name: Build documentation and examples | |
run: | | |
pip install -r docs/requirements.txt | |
sphinx-build -b html docs docs/_build | |
sphinx-build -b doctest docs docs/_build | |
- name: Lint with Ruff | |
uses: astral-sh/ruff-action@v1 | |
- name: Run tests and generate coverage data | |
run: | | |
python3 -m pip install coverage pytest | |
coverage run -m pytest | |
- name: Upload coverage to Codecov | |
uses: codecov/codecov-action@v5 | |
with: | |
token: ${{ secrets.CODECOV_TOKEN }} | |
flags: unittests | |
name: codecov-umbrella | |
fail_ci_if_error: false |