Skip to content

Conversation

@hmellor
Copy link
Member

@hmellor hmellor commented Oct 16, 2025

Practical outcomes of this PR:


Changes:

  • Replace gh-file and gh-dir with normal relative links and add parsing to convert relative links outside of docs/ into GitHub URLs
  • Replace gh-pr, gh-issue, gh-project with full links and when they are detected:
    • Add a GitHub icon to the start of every link
    • Raw links (<https://...>) are replaced with [Issue #XYZ](https://...) etc

Notable other changes:

  • GPU and CPU snippet docs brought one level up so that any relative links they contain will be from the same level as the document they will end up in

@mergify
Copy link

mergify bot commented Oct 16, 2025

Documentation preview: https://vllm--27009.org.readthedocs.build/en/27009/

@mergify mergify bot added documentation Improvements or additions to documentation structured-output labels Oct 16, 2025
@hmellor hmellor changed the title Use GitHub style autilinks instead of MuST style shortlinks [Docs] Reduce custom syntax used in docs Oct 16, 2025
@mergify mergify bot added tpu Related to Google TPUs tool-calling labels Oct 16, 2025
Signed-off-by: Harry Mellor <[email protected]>
@hmellor hmellor requested a review from DarkLight1337 October 16, 2025 16:18
@hmellor hmellor marked this pull request as ready for review October 16, 2025 16:18
@hmellor hmellor requested a review from noooop as a code owner October 16, 2025 16:18
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR.

- Whisper encoder–decoder (audio-only): <gh-file:vllm/model_executor/models/whisper.py>
- Voxtral decoder-only (audio embeddings + LLM): <gh-file:vllm/model_executor/models/voxtral.py>
- Gemma3n decoder-only with fixed instruction prompt: <gh-file:vllm/model_executor/models/gemma3n_mm.py>
- Whisper encoder–decoder (audio-only): [vllm/model_executor/models/whisper.py](../../../vllm/model_executor/models/whisper.py)
Copy link
Member

@DarkLight1337 DarkLight1337 Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this actually work after building the docs (not locally)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@vllm-bot vllm-bot merged commit 4ffd6e8 into vllm-project:main Oct 17, 2025
5 checks passed
Zhuul pushed a commit to Zhuul/vllm that referenced this pull request Oct 17, 2025
@hmellor hmellor deleted the github-autolinks branch October 17, 2025 07:32
lywa1998 pushed a commit to lywa1998/vllm that referenced this pull request Oct 20, 2025
albertoperdomo2 pushed a commit to albertoperdomo2/vllm that referenced this pull request Oct 23, 2025
alhridoy pushed a commit to alhridoy/vllm that referenced this pull request Oct 24, 2025
xuebwang-amd pushed a commit to xuebwang-amd/vllm that referenced this pull request Oct 24, 2025
xuebwang-amd pushed a commit to xuebwang-amd/vllm that referenced this pull request Oct 24, 2025
0xrushi pushed a commit to 0xrushi/vllm that referenced this pull request Oct 26, 2025
0xrushi pushed a commit to 0xrushi/vllm that referenced this pull request Oct 26, 2025
rtourgeman pushed a commit to rtourgeman/vllm that referenced this pull request Nov 10, 2025
Zhathw pushed a commit to Zhathw/vllm that referenced this pull request Nov 12, 2025
devpatelio pushed a commit to SumanthRH/vllm that referenced this pull request Nov 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation structured-output tool-calling tpu Related to Google TPUs

Projects

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants