[CI/Build] Add sphinx/rst linter for docs #10366
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,30 @@ | ||||||
| name: Lint documentation | ||||||
|
|
||||||
| on: | ||||||
| push: | ||||||
| branches: | ||||||
| - main | ||||||
| paths: | ||||||
| - "docs/**" | ||||||
| pull_request: | ||||||
| branches: | ||||||
| - main | ||||||
|
|
||||||
| jobs: | ||||||
| doc8: | ||||||
| runs-on: ubuntu-latest | ||||||
| strategy: | ||||||
| matrix: | ||||||
| python-version: ["3.12"] | ||||||
| steps: | ||||||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||||||
| - name: Set up Python ${{ matrix.python-version }} | ||||||
| uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | ||||||
| with: | ||||||
| python-version: ${{ matrix.python-version }} | ||||||
| - name: Install dependencies | ||||||
| run: | | ||||||
| python -m pip install --upgrade pip | ||||||
| pip install sphinx-lint | ||||||
|
||||||
| pip install sphinx-lint | |
| pip install -r requirements-lint.txt |
Outdated
There was a problem hiding this comment.
and I would change this to:
Suggested change
| run: sphinx-lint docs | |
| run: tools/sphinx-lint.sh |
This ensures that we use the same arguments to the tool for both CI and local usage.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
any reason you have
pathsset for pushes but not PRs?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No reason, nice catch!