Skip to content

Merge pull request #104 from 4Freye/develop #302

Merge pull request #104 from 4Freye/develop

Merge pull request #104 from 4Freye/develop #302

Workflow file for this run

name: CI
permissions:
contents: write
on:
push:
pull_request:
branches: [ main ]
jobs:
test:
name: Run tests on Python ${{ matrix.python-version }}
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.11", "3.12", "3.13", "3.14"]
fail-fast: true
steps:
- name: Check out repository code
uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install uv
run: |
curl -LsSf https://astral.sh/uv/install.sh | sh
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Install dependencies
run: uv sync --dev
- name: Run tests
run: uv run pytest
docs:
# Only run this job on push to main (includes merges) and if tests pass
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: test # Only build docs if tests pass
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
- name: Install dependencies and generate documentation
run: |
curl -LsSf https://astral.sh/uv/install.sh | sh
uv sync
rm -rf docs # Remove old docs directory if it exists
uv run pdoc panelsplit -o docs --no-include-undocumented --docformat numpy
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs