Skip to content

Try to fix README formatting [CI skip] #4

Try to fix README formatting [CI skip]

Try to fix README formatting [CI skip] #4

Workflow file for this run

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: CI
on:
push:
branches: ["main", "dev"]
pull_request:
branches: ["main", "dev"]
jobs:
test:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.10", "3.11"]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- uses: astral-sh/setup-uv@v6
with:
version: "latest"
- name: Install dependencies
run: uv sync --group dev
- name: Run tests
run: uv run pytest
- name: Install package
run: uv pip install .
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- uses: astral-sh/setup-uv@v6
with:
version: "latest"
- name: Install dependencies with docs extra
run: uv sync --extra docs
- name: Build documentation
run: uv run sphinx-build -b html -W --keep-going docs/source docs/_build/html
- name: Upload documentation artifacts
uses: actions/upload-artifact@v4
with:
name: documentation
path: docs/_build/html