amoeba opened a new pull request, #40022:
URL: https://github.com/apache/arrow/pull/40022

   ### What changes are included in this PR?
   
   This operationalizes sphinx-lint for docs linting. Specifically:
   
   - Enables sphinx-lint by adding a `--docs` option to `archery lint` that 
runs sphinx-lint on `./docs` with only two checks enabled, as discussed in 
https://github.com/apache/arrow/issues/39990.
   - Extends `archery lint` to support being given an optional path. This lets 
archery lint be used as a pre-commit hook because pre-commit hook commands need 
to be able to take a path.
   - Enables sphinx-lint in CI via existing archery task
   - Adds a pre-commit hook for files in `./docs` that runs sphinx-lint (via 
`archery lint --docs`)
   - Adds sphinx-lint as a dependency where appropriate so its available in 
developer environments and on CI
   
   ### Are these changes tested?
   
   WIP, I'm going to list my manual test cases here.
   
   ### 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. Contributors working on the docs may see CI failures related to the new 
checks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to