refactor: simplify README and add comprehensive documentation #13
This file contains hidden or 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: Tests | |
| on: | |
| push: | |
| branches: [ main, develop, lanzelot-dev ] | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| test: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest, macos-latest] | |
| python-version: ['3.9', '3.10', '3.11', '3.12'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e .[dev] | |
| pip install -r requirements.txt | |
| - name: Run tests | |
| run: | | |
| python -m pytest tests/ -v | |
| - name: Check code formatting (Linux only) | |
| if: matrix.os == 'ubuntu-latest' | |
| run: | | |
| black --check ace/ | |
| - name: Type checking (Linux only) | |
| if: matrix.os == 'ubuntu-latest' | |
| run: | | |
| mypy ace/ --ignore-missing-imports |