Include arbitrary function call in Readme #268
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: | |
test: | |
name: Lint and Test | |
runs-on: ubuntu-latest | |
strategy: | |
max-parallel: 4 | |
matrix: | |
python-version: [3.8, 3.9, "3.10", 3.11] | |
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 Package | |
run: | | |
pip install -e . | |
- name: Check with ruff format | |
run: | | |
pip install ruff | |
ruff format | |
- name: Check with ruff | |
run: | | |
pip install ruff | |
ruff . | |
- name: Check with mypy | |
run: | | |
pip install mypy types-dataclasses | |
mypy | |
- name: Test with pytest | |
run: | | |
pip install -e ".[dev]" | |
pytest | |
build-documentation: | |
name: Build Sphinx Documentation | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Set up Python 3.11 | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.11 | |
- name: Build | |
run: | | |
pip install -e ".[doc]" | |
cd docs | |
make clean | |
make html |