fix: fix sphinx documentation #10085
Workflow file for this run
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: Linting | |
| on: | |
| push: | |
| pull_request: | |
| types: [opened, synchronize, reopened, edited] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| linting: | |
| name: Linting | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| tool: ['isort', 'black', 'pyupgrade', 'flake8', 'bandit', 'gitlint', 'mypy', 'interrogate'] | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/harden-runner@a90bcbc6539c36a85cdfeb73f7e2f433735f215b # v2.15.0 | |
| with: | |
| egress-policy: audit | |
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0 | |
| with: | |
| python-version: '3.11' | |
| cache: 'pip' | |
| - name: Install pre-commit | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install --upgrade setuptools | |
| python -m pip install --upgrade pre-commit | |
| pre-commit install | |
| - name: Run ${{ matrix.tool }} using pre-commit | |
| if: ${{ matrix.tool != 'gitlint' }} | |
| run: | | |
| pre-commit run ${{ matrix.tool }} --all-files | |
| - name: Run gitlint | |
| env: | |
| TITLE: ${{ github.event.pull_request.title }} | |
| if: ${{ github.event_name == 'pull_request' && matrix.tool == 'gitlint' }} | |
| run: | | |
| python -m pip install --upgrade gitlint | |
| echo "$TITLE" | gitlint | |