docs: Update documentation for multi-language support and language sw… #57
Workflow file for this run
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: MR Checks | |
| on: | |
| pull_request: | |
| paths-ignore: | |
| - '**.md' | |
| - '.github/**' | |
| - '!.github/workflows/**' | |
| - 'docs/**' | |
| - '**.rst' | |
| jobs: | |
| lint: | |
| name: Code Style Check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| cache: 'pip' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install nox | |
| - name: Run lint checks | |
| run: | | |
| nox -s lint | |
| docs: | |
| name: Documentation Check | |
| runs-on: ubuntu-latest | |
| if: | | |
| contains(github.event.pull_request.changed_files, 'docs/') || | |
| contains(github.event.pull_request.changed_files, '.rst') || | |
| contains(github.event.pull_request.changed_files, '.md') || | |
| contains(github.event.pull_request.changed_files, 'nox_actions/docs.py') || | |
| contains(github.event.pull_request.changed_files, 'pyproject.toml') | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| cache: 'pip' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install nox | |
| - name: Run documentation checks | |
| run: | | |
| nox -s docs-lint | |
| nox -s docs-build | |
| test: | |
| name: Python ${{ matrix.python-version }} Tests | |
| needs: [lint, docs] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, windows-latest, macos-latest] | |
| python-version: ['3.8', '3.9', '3.10', '3.11', '3.12'] | |
| exclude: | |
| # Exclude some combinations to reduce CI time | |
| - os: macos-latest | |
| python-version: '3.8' | |
| - os: macos-latest | |
| python-version: '3.9' | |
| - os: windows-latest | |
| python-version: '3.8' | |
| - os: windows-latest | |
| python-version: '3.9' | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: 'pip' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install nox | |
| - name: Run tests | |
| run: | | |
| nox -s pytest | |
| - name: Run type checks | |
| run: | | |
| nox -s type_check |