[Docs] Fix warnings in mkdocs build (continued) #25163
Merged
+3
−7
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
WARNING - mkdocs_autorefs: api/vllm/entrypoints/openai/serving_engine.md: from /Users/zerohertz/Downloads/opensources/vllm/vllm/entrypoints/openai/serving_engine.py:699: (vllm.entrypoints.openai.serving_engine.OpenAIServing._tokenize_prompt_input_async) Could not find cross-reference target 'vllm.entrypoints.openai.serving_engine.OpenAIServing._tokenize_prompt_input_or_inputs' WARNING - mkdocs_autorefs: api/vllm/entrypoints/openai/serving_engine.md: from /Users/zerohertz/Downloads/opensources/vllm/vllm/entrypoints/openai/serving_engine.py:720: (vllm.entrypoints.openai.serving_engine.OpenAIServing._tokenize_prompt_inputs_async) Could not find cross-reference target 'vllm.entrypoints.openai.serving_engine.OpenAIServing._tokenize_prompt_input_or_inputs' Signed-off-by: Zerohertz <[email protected]>
WARNING - griffe: vllm/distributed/device_communicators/shm_object_storage.py:255: Failed to get 'name: description' pair from 'frees the maximum size of the ring buffer.' Signed-off-by: Zerohertz <[email protected]>
![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 addresses several documentation build warnings. The changes include fixing a docstring format issue in vllm/distributed/device_communicators/shm_object_storage.py by adding correct indentation, and removing broken cross-references in docstrings within vllm/entrypoints/openai/serving_engine.py. These changes are straightforward, correct, and effectively resolve the specified warnings, improving the overall quality of the documentation. The code modifications are well-contained and do not introduce any functional changes or issues. The pull request is good to merge.
hmellor
approved these changes
Sep 18, 2025
debroy-rh
pushed a commit
to debroy-rh/vllm
that referenced
this pull request
Sep 19, 2025
Signed-off-by: Zerohertz <[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.
Continued #23649, #23743, #24092, #24740, #24791
Related: #25020
Note
Warnings fixed: