kumarUjjawal opened a new pull request, #25586:
URL: https://github.com/apache/datafusion/pull/25586
## Which issue does this PR close?
- Part of #21048.
## Rationale for this change
`./dev/rust_lint.sh` runs the non-functional CI checks locally, but not the
documentation website build. Sphinx builds with `-W`, so one warning fails
CI.
A contributor sees that failure only after a push.
## What changes are included in this PR?
- `ci/scripts/check_docs_html.sh` runs the existing `docs/build.sh` through
uv.
It works from any directory. It reports a missing `uv`, `cargo`,
`cargo-depgraph`, `dot`, or `make` before the build starts, and installs
nothing. It has no write mode.
- `dev/rust_lint.sh` runs the new script as a read-only step.
- The "Test doc build" job runs the same script. The path filters of the job
also watch the script.
- `docs/source/contributor-guide/testing.md` documents the command.
`docs/build.sh` still owns the Sphinx and dependency-graph commands. The
Python
dependencies and the Sphinx settings do not change.
## What is the testing strategy for this PR?
Local checks with command stubs and a real build:
- The script starts the same build from the repository root and from other
directories.
- `-h`, `--help`, `--write`, `--allow-dirty`, and an unknown flag all fail
before any tool runs.
- Each missing tool gives one message and a non-zero exit.
- Failures in `uv`, `cargo depgraph`, and `dot` keep their exit code.
- A real build writes `docs/build/html/index.html` and changes no tracked
file.
- One Sphinx warning, a page outside every toctree, fails the build.
`uv run ./dev/rust_lint.sh` passes with the new step.
## Are there any user-facing changes?
No. This changes the contributor tooling only.
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
