GH-39990: [Docs][CI] Add sphinx-lint for docs linting #40022
Merged
Conversation
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
github-actions
bot
added
Component: Documentation
awaiting review
4 tasks
amoeba
force-pushed
the
gh-39990-docs-lint
branch
from
47921d1
to
cd06982
Compare
kou
reviewed
Mar 18, 2024
|
Could you rebase on main? |
|
Thanks @kou. I need to fix a couple merge conflicts during rebase and I'll ping you once this is ready. |
amoeba
force-pushed
the
gh-39990-docs-lint
branch
from
1aabd9a
to
4fc374f
Compare
|
Hi @kou, I rebased and pushed a few extra changes. I just tested the behavior |
github-actions
bot
added
awaiting merge
|
Could you update the description before we merge this? |
github-actions
bot
added
awaiting changes
github-actions
bot
added
awaiting change review
|
Sorry for not doing that before asking for another review @kou. Description updated. Feedback from the last 24hours has all been addressed as well. |
sphinx-lint --disable all --enable trailing-whitespace,missing-final-newline
- Adds sphinx-lint to archery as archer lint --docs - Adds archery lint --docs to pre-commit hook - Adds sphinx-lint to appropriate setup.py, conda lock, and requirements.txt
|
I rebased, pushed two fixes in recent changes and will merge this once CI passes. |
|
Merged. There were two failing CI checks but both were unrelated (recent pyarrow asof join failures, both have their own issues). Thanks for the review here @kou and @jorisvandenbossche. |
|
Thanks @amoeba! Are there other rules we want to consider enabling as follow-ups? |
|
After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit 0f7e9af. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. It also includes information about 45 possible false positives for unstable benchmarks that are known to sometimes produce them. |
tolleybot
pushed a commit
to tmct/arrow
that referenced
this pull request
May 2, 2024
…0022) ### What changes are included in this PR? This adds developer tooling to the repo for linting the docs by adding the sphinx-lint tool to archery and our pre-commit hooks. In both locations, only two rules are enabled at the moment (Discussed in apache#40006): `trailing-whitespace` and `missing-final-newline`. This PR also fixes the individual issues covered by the new tooling. ### Are these changes tested? Yes, though manually. I tested this works by running `archery lint --docs` and `pre-commit` without and without changes that should get caught by the rules. It works as expected. ### Are there any user-facing changes? Yes, 1. Developers that use pre-commit hooks will see a change in behavior when they modify docs 2. Developers using archery will see a new --docs option in `archery lint` 3. Developers working on the docs may see CI failures related to the new checks * Closes: apache#39990 * GitHub Issue: apache#39990 Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
tolleybot
pushed a commit
to tmct/arrow
that referenced
this pull request
May 4, 2024
…0022) ### What changes are included in this PR? This adds developer tooling to the repo for linting the docs by adding the sphinx-lint tool to archery and our pre-commit hooks. In both locations, only two rules are enabled at the moment (Discussed in apache#40006): `trailing-whitespace` and `missing-final-newline`. This PR also fixes the individual issues covered by the new tooling. ### Are these changes tested? Yes, though manually. I tested this works by running `archery lint --docs` and `pre-commit` without and without changes that should get caught by the rules. It works as expected. ### Are there any user-facing changes? Yes, 1. Developers that use pre-commit hooks will see a change in behavior when they modify docs 2. Developers using archery will see a new --docs option in `archery lint` 3. Developers working on the docs may see CI failures related to the new checks * Closes: apache#39990 * GitHub Issue: apache#39990 Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
rok
pushed a commit
to tmct/arrow
that referenced
this pull request
May 8, 2024
…0022) ### What changes are included in this PR? This adds developer tooling to the repo for linting the docs by adding the sphinx-lint tool to archery and our pre-commit hooks. In both locations, only two rules are enabled at the moment (Discussed in apache#40006): `trailing-whitespace` and `missing-final-newline`. This PR also fixes the individual issues covered by the new tooling. ### Are these changes tested? Yes, though manually. I tested this works by running `archery lint --docs` and `pre-commit` without and without changes that should get caught by the rules. It works as expected. ### Are there any user-facing changes? Yes, 1. Developers that use pre-commit hooks will see a change in behavior when they modify docs 2. Developers using archery will see a new --docs option in `archery lint` 3. Developers working on the docs may see CI failures related to the new checks * Closes: apache#39990 * GitHub Issue: apache#39990 Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
rok
pushed a commit
to tmct/arrow
that referenced
this pull request
May 8, 2024
…0022) ### What changes are included in this PR? This adds developer tooling to the repo for linting the docs by adding the sphinx-lint tool to archery and our pre-commit hooks. In both locations, only two rules are enabled at the moment (Discussed in apache#40006): `trailing-whitespace` and `missing-final-newline`. This PR also fixes the individual issues covered by the new tooling. ### Are these changes tested? Yes, though manually. I tested this works by running `archery lint --docs` and `pre-commit` without and without changes that should get caught by the rules. It works as expected. ### Are there any user-facing changes? Yes, 1. Developers that use pre-commit hooks will see a change in behavior when they modify docs 2. Developers using archery will see a new --docs option in `archery lint` 3. Developers working on the docs may see CI failures related to the new checks * Closes: apache#39990 * GitHub Issue: apache#39990 Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
|
Good reminder, thanks @jorisvandenbossche. I think quite a few would be good to add. I've filed #41611 for that work. |
vibhatha
pushed a commit
to vibhatha/arrow
that referenced
this pull request
May 25, 2024
…0022) ### What changes are included in this PR? This adds developer tooling to the repo for linting the docs by adding the sphinx-lint tool to archery and our pre-commit hooks. In both locations, only two rules are enabled at the moment (Discussed in apache#40006): `trailing-whitespace` and `missing-final-newline`. This PR also fixes the individual issues covered by the new tooling. ### Are these changes tested? Yes, though manually. I tested this works by running `archery lint --docs` and `pre-commit` without and without changes that should get caught by the rules. It works as expected. ### Are there any user-facing changes? Yes, 1. Developers that use pre-commit hooks will see a change in behavior when they modify docs 2. Developers using archery will see a new --docs option in `archery lint` 3. Developers working on the docs may see CI failures related to the new checks * Closes: apache#39990 * GitHub Issue: apache#39990 Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changes are included in this PR?
This adds developer tooling to the repo for linting the docs by adding the sphinx-lint tool to archery and our pre-commit hooks. In both locations, only two rules are enabled at the moment (Discussed in #40006):
trailing-whitespaceandmissing-final-newline.This PR also fixes the individual issues covered by the new tooling.
Are these changes tested?
Yes, though manually. I tested this works by running
archery lint --docsandpre-commitwithout and without changes that should get caught by the rules. It works as expected.Are there any user-facing changes?
Yes,
archery lint