Minor doc improvements #167
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: CI | |
| on: | |
| push: | |
| branches: [main, reorg] | |
| tags: ["*"] | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| test: | |
| name: Python ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }} | |
| runs-on: ${{ matrix.os }} | |
| continue-on-error: ${{ matrix.experimental }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| version: ["3.9", "3.10", "3.11", "3.12"] | |
| os: [ubuntu-latest] | |
| arch: [x64] | |
| experimental: [false] | |
| #include: | |
| # - version: "3.12-dev" | |
| # os: ubuntu-latest | |
| # arch: x64 | |
| # experimental: true | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.version }} | |
| cache: 'pip' | |
| cache-dependency-path: pyproject.toml | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e '.[dev]' | |
| - name: Test | |
| run: pytest | |
| - name: Test notebooks | |
| run: pytest --nbmake examples/*.ipynb --nbmake-kernel=python3 | |
| type-check: | |
| name: Type Check | |
| runs-on: ubuntu-latest | |
| continue-on-error: true | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.12 | |
| cache: 'pip' | |
| cache-dependency-path: pyproject.toml | |
| - name: Install dependencies | |
| id: deps | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -e '.[dev]' | |
| - name: Type check 3.10 | |
| if: ${{ steps.deps.outcome == 'success' && success() || failure() }} | |
| uses: jakebailey/pyright-action@v1 | |
| with: | |
| python-version: "3.10" | |
| - name: Type check 3.12 | |
| if: ${{ steps.deps.outcome == 'success' && success() || failure() }} | |
| uses: jakebailey/pyright-action@v1 | |
| with: | |
| python-version: "3.12" | |
| success: | |
| name: Success | |
| runs-on: ubuntu-latest | |
| needs: [test, type-check] | |
| steps: | |
| - run: exit 0 |