Consolidate setup.cfg and pyproject.toml; drop tox; revamp sphinx docs #103
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: Check style + docs + types | |
on: | |
pull_request: | |
jobs: | |
check: | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
working-directory: . | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python 3.12 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.12" | |
cache: 'pip' | |
cache-dependency-path: '**/pyproject.toml' | |
- name: Install package with development dependencies | |
run: pip install -e ".[dev]" | |
if: steps.python-cache.outputs.cache-hit != 'true' | |
# check code style | |
- name: Run black | |
run: black src --check --diff | |
# check docs | |
- name: Check that documentation can be built | |
run: sphinx-build docs docs/_build # --fail-on-warning | |
# check types with mypy | |
- name: Check types in python src directory; install needed types | |
run: mypy --install-types --non-interactive src | |
# use treon to make sure that example notebooks run | |
- name: Check jupyter notebooks with treon | |
run: treon |