Skip to content

[Docs] Fix broken autorefs cross-reference in TurboQuant v2 docstring - #51857

Merged
vllm-bot merged 2 commits into
vllm-project:mainfrom
hmellor:fix-docs-autorefs-pair-table
Aug 11, 2026
Merged

vllm-bot merged 2 commits into
vllm-project:mainfrom
hmellor:fix-docs-autorefs-pair-table

Conversation

@hmellor

@hmellor hmellor commented Aug 11, 2026

Copy link
Copy Markdown
Member

Purpose

The docs build emits exactly one WARNING, from the triton_turboquant_decode_v2 module docstring:

WARNING -  mkdocs_autorefs: api/vllm/v1/attention/ops/turboquant_soa/triton_turboquant_decode_v2.md: from .../triton_turboquant_decode_v2.py:3: (vllm.v1.attention.ops.turboquant_soa.triton_turboquant_decode_v2) Could not find cross-reference target 'j'

The docstring writes pair_table[i][j] unquoted. Markdown parses [i][j] as a full reference link (text i, reference j), mkdocs-autorefs then tries to resolve j as a cross-reference target and fails. Wrapping the expression in backticks makes it render as code, which is also how the same construct is already written elsewhere in the codebase (e.g. `blocks[i][j]` in vllm/v1/core/kv_cache_manager.py).

Docstring text only, no functional change.

Not a duplicate

Checked with:

gh pr list --repo vllm-project/vllm --state open --search "autorefs cross-reference docstring"
gh pr list --repo vllm-project/vllm --state open --search "turboquant"

No open PR touches this docstring or the autorefs warning.

Test Plan

Full mkdocs build before and after the change, with all output captured (not just the tail).

Test Result

Before (on upstream/main @ 52be12cfac):

$ grep -c '^WARNING' build_before.log
1
$ grep '^WARNING' build_before.log
WARNING -  mkdocs_autorefs: api/vllm/v1/attention/ops/turboquant_soa/triton_turboquant_decode_v2.md: ... Could not find cross-reference target 'j'

After:

$ grep -c '^WARNING' build_after.log
0
INFO    -  Documentation built in 398.40 seconds

pre-commit run --files vllm/v1/attention/ops/turboquant_soa/triton_turboquant_decode_v2.py passes.

No model evaluation is included because the change is confined to a module docstring and cannot affect output, accuracy, or serving.

Note

AI assistance (Claude Code) was used for this change. I have reviewed every changed line and run the commands above myself.

The module docstring wrote `pair_table[i][j]` unquoted, which Markdown
parses as a reference link and mkdocs-autorefs then fails to resolve,
emitting the only WARNING in the docs build. Wrap the expression in
backticks so it renders as code.

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Harry Mellor <hej.mellor@gmail.com>

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@mergify mergify Bot added the quantization label Aug 11, 2026
@AndreasKaratzas

Copy link
Copy Markdown
Member

/ci run

@github-actions

Copy link
Copy Markdown

✅ Triggered Buildkite CI #83408 for commit 9db8b8a237f4.

@AndreasKaratzas

Copy link
Copy Markdown
Member

/ci run

@github-actions

Copy link
Copy Markdown

✅ Triggered Buildkite CI #83414 for commit 4db40c835b50.

@vllm-bot
vllm-bot merged commit b2ab096 into vllm-project:main Aug 11, 2026
22 of 94 checks passed
@hmellor
hmellor deleted the fix-docs-autorefs-pair-table branch August 11, 2026 20:31
zyp2014 pushed a commit to zyp2014/vllm that referenced this pull request Aug 21, 2026
…vllm-project#51857)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Andreas Karatzas <akaratza@amd.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants