pybricks-api/.github/workflows/build.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Build Python package and docs

on: 
  push:
    tags-ignore:
      - '**'
  pull_request:
    paths:
      - doc/**
      - src/**
      - poetry.lock
      - poetry.toml
      - pyproject.toml
      - setup.cfg


jobs:
  build:

    runs-on: ubuntu-24.04
    steps:
    - uses: actions/checkout@v6
      with:
        submodules: recursive
    - name: Install dependencies
      run: |
        pipx install poetry
        poetry install
    - name: Lint Python code
      run: poetry run ruff check
    - name: Check Python formatting
      run: poetry run ruff format --check
    - name: Build package
      run: poetry build
    - name: Lint docs
      run: poetry run doc8
    - name: Build html docs for Read the Docs
      run: poetry run make -C doc html
    - name: Build html docs for Pybricks Code IDE
      run: poetry run make -C doc html TAG=ide