[Docs] Enable fail_on_warning for the docs build in CI
#25580
Merged
Conversation
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
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
hmellor
requested review from
22quinn,
LucasWilkinson,
WoosukKwon,
aarnphm,
alexm-redhat,
chaunceyjiang,
comaniac,
mgoin,
njhill,
robertgshaw2-redhat,
sighingnow and
ywang96
as code owners
mergify
bot
added
documentation
70 tasks
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request enables fail_on_warning for the documentation build in CI, which is a great step towards improving documentation quality. The changes include a wide range of fixes to address existing warnings, such as correcting broken links in markdown files, fixing malformed docstrings across various Python modules, and improving type hints. All the changes are appropriate and contribute to a cleaner and more maintainable codebase. I have one suggestion to improve a docstring further, but overall the PR is well-executed.
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
russellb
approved these changes
Sep 24, 2025
github-actions
bot
added
the
ready
DarkLight1337
approved these changes
Sep 24, 2025
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
yewentao256
pushed a commit
that referenced
this pull request
Oct 3, 2025
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: yewentao256 <zhyanwentao@126.com>
xuebwang-amd
pushed a commit
to xuebwang-amd/vllm
that referenced
this pull request
Oct 10, 2025
…t#25580) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: xuebwang-amd <xuebwang@amd.com>
choprahetarth
pushed a commit
to Tandemn-Labs/vllm
that referenced
this pull request
Oct 11, 2025
…t#25580) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
lywa1998
pushed a commit
to lywa1998/vllm
that referenced
this pull request
Oct 20, 2025
…t#25580) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Enables
fail_on_warningso that docs issues such as broken links can be caught in CI.Closes #25020