use the readthedocs sphinx theme for docs #26
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: Python package | |
on: [push] | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
# Note we don't test versions < 3.9 as some dev deps require >= 3.9 | |
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install ruff pytest mypy black | |
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | |
- name: Style with black | |
run: | | |
black --check . | |
- name: Lint with ruff | |
run: | | |
# stop the build if there are Python syntax errors or undefined names | |
ruff check --select=E9,F63,F7,F82 --target-version=py37 . | |
# default set of ruff rules with GitHub Annotations | |
ruff check --target-version=py37 . | |
- name: Typecheck with mypy | |
run: | | |
mypy src/ tests/ | |
- name: Test with pytest | |
run: | | |
pytest . |