Improve sphinx documentation rendering to use autodoc type hints for params and not in signatures #820
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: changelog | |
| on: | |
| workflow_call: | |
| pull_request: | |
| types: | |
| - labeled | |
| - unlabeled | |
| - opened | |
| - reopened | |
| - synchronize | |
| jobs: | |
| check_has_news_in_changelog_dir: | |
| if: | | |
| ! ( | |
| contains(github.event.pull_request.labels.*.name, 'no-news-is-good-news') || | |
| github.event.pull_request.user.login == 'pre-commit-ci[bot]' || | |
| github.event.pull_request.user.login == 'dependabot[bot]' | |
| ) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | |
| with: # do a deep fetch to allow merge-base and diff | |
| fetch-depth: 0 | |
| - name: check PR adds a news file | |
| run: | | |
| news_files="$(git diff --name-only "$(git merge-base origin/main "$GITHUB_SHA")" "$GITHUB_SHA" -- changelog.d/*.rst)" | |
| if [ -n "$news_files" ]; then | |
| echo "Saw new files. changelog.d:" | |
| echo "$news_files" | |
| else | |
| echo "No news files seen" | |
| exit 1 | |
| fi |