Skip to content

[Docs] Fix some snippets#31378

Merged
DarkLight1337 merged 1 commit intovllm-project:mainfrom
hmellor:fix-docs
Dec 26, 2025
Merged

[Docs] Fix some snippets#31378
DarkLight1337 merged 1 commit intovllm-project:mainfrom
hmellor:fix-docs

Conversation

@hmellor
Copy link
Copy Markdown
Member

@hmellor hmellor commented Dec 26, 2025

  • Engine args page was including .md files (which don't exist) where they should have been .inc.md files
  • Update generate_metrics.py to use .inc.md
  • Update generate_argparse.py to use the docs/generated/argparse output dir

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@chatgpt-codex-connector
Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.

@mergify
Copy link
Copy Markdown

mergify bot commented Dec 26, 2025

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

@mergify mergify bot added the documentation Improvements or additions to documentation label Dec 26, 2025
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request addresses several issues with the documentation generation process. It corrects the output directory for argparse documentation, updates the file extension for generated metrics files to .inc.md, and modifies all relevant markdown files to include snippets from the correct paths. The changes are consistent and effectively fix the broken documentation links. The code modifications are correct and well-contained.

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) December 26, 2025 12:46
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Dec 26, 2025
@DarkLight1337 DarkLight1337 merged commit 0b544e6 into vllm-project:main Dec 26, 2025
14 checks passed
@hmellor hmellor deleted the fix-docs branch December 26, 2025 23:14
patrickvonplaten pushed a commit to patrickvonplaten/vllm that referenced this pull request Dec 27, 2025
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Patrick von Platen <patrick.v.platen@gmail.com>
yiliu30 pushed a commit to yiliu30/vllm-fork that referenced this pull request Dec 30, 2025
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
dsuhinin pushed a commit to dsuhinin/vllm that referenced this pull request Jan 21, 2026
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: dsuhinin <suhinin.dmitriy@gmail.com>
ItzDEXX pushed a commit to ItzDEXX/vllm that referenced this pull request Feb 19, 2026
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

Labels

documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants