docs: add more links and some updates #482
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: CI | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| release: | |
| types: | |
| - published | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| FORCE_COLOR: 3 | |
| jobs: | |
| pre-commit: | |
| name: Format | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.x" | |
| - uses: pre-commit/action@v3.0.0 | |
| with: | |
| extra_args: --hook-stage manual --all-files | |
| - name: Run PyLint | |
| run: | | |
| echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json" | |
| pipx run --python=python nox -s pylint | |
| checks: | |
| name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }} | |
| runs-on: ${{ matrix.runs-on }} | |
| needs: [pre-commit] | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12-dev"] | |
| runs-on: [ubuntu-latest, macos-latest, windows-latest] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install package | |
| run: python -m pip install .[test,cli] | |
| - name: Test package | |
| run: python -m pytest -ra | |
| env: | |
| PYTHONUTF8: "1" | |
| dist: | |
| name: Distribution build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - uses: hynek/build-and-inspect-python-package@v1 | |
| docs: | |
| name: Docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - uses: wntrblm/nox@2023.04.22 | |
| with: | |
| python-versions: "3.11" | |
| - name: Linkcheck | |
| run: nox -s docs -- -b linkcheck | |
| - name: Build docs with warnings as errors | |
| run: nox -s docs -- -W | |
| - name: Verify no changes required to API docs | |
| run: | | |
| nox -s build_api_docs | |
| git diff --exit-code | |
| action: | |
| name: Action | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Run repo-review action | |
| uses: ./ | |
| with: | |
| plugins: sp-repo-review==2023.07.13 |