Skip to content

Add API docs link if the CLI arg is a config class#37432

Merged
DarkLight1337 merged 2 commits intovllm-project:mainfrom
hmellor:help-docs-link
Mar 18, 2026
Merged

Add API docs link if the CLI arg is a config class#37432
DarkLight1337 merged 2 commits intovllm-project:mainfrom
hmellor:help-docs-link

Conversation

@hmellor
Copy link
Copy Markdown
Member

@hmellor hmellor commented Mar 18, 2026

A QoL improvement for configs that are directly exposed to the CLI so that their API documentation is linked to.

$ vllm serve --help=VllmConfig
...
  --attention-config ATTENTION_CONFIG, -ac ATTENTION_CONFIG
                        Attention configuration.
                        API docs: https://docs.vllm.ai/en/latest/api/vllm/config/#vllm.config.AttentionConfig
                        Should either be a valid JSON string or JSON keys passed individually. (default: ...

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
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

The pull request introduces a quality-of-life improvement by adding API documentation links to CLI help messages for configuration classes. The implementation adds a new helper function _maybe_add_docs_url to generate these links and integrates it into the argument parsing logic. One area for improvement is the placement of an import statement within a function, which can lead to unnecessary overhead.

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) March 18, 2026 14:44
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Mar 18, 2026
@DarkLight1337 DarkLight1337 merged commit 39bfb57 into vllm-project:main Mar 18, 2026
50 checks passed
@hmellor hmellor deleted the help-docs-link branch March 18, 2026 22:11
fxdawnn pushed a commit to fxdawnn/vllm that referenced this pull request Mar 19, 2026
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
SouthWest7 pushed a commit to SouthWest7/vllm that referenced this pull request Mar 27, 2026
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
khairulkabir1661 pushed a commit to khairulkabir1661/vllm that referenced this pull request Mar 27, 2026
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Monishver11 pushed a commit to Monishver11/vllm that referenced this pull request Mar 27, 2026
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Monishver Chandrasekaran <monishverchandrasekaran@gmail.com>
JiantaoXu pushed a commit to JiantaoXu/vllm that referenced this pull request Mar 28, 2026
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
vrdn-23 pushed a commit to vrdn-23/vllm that referenced this pull request Mar 30, 2026
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Vinay Damodaran <vrdn@hey.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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