Skip to content

Conversation

hmellor
Copy link
Member

@hmellor hmellor commented Aug 26, 2025

I noticed that math rendering was broken.

I've updated it to use the plugin bundled with MkDocs Material as documented in https://squidfunk.github.io/mkdocs-material/reference/math/#mathjax.

You can verify that it's working by going to the Softmax section of the Paged Attention design doc.

Signed-off-by: Harry Mellor <[email protected]>
@mergify mergify bot added documentation Improvements or additions to documentation ci/build labels Aug 26, 2025
Copy link
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 correctly fixes the math rendering in the documentation by migrating from mdx_math to the recommended pymdownx.arithmatex extension with MathJax 3, as suggested by the mkdocs-material theme documentation. The changes are well-implemented, including the new MathJax configuration script and dependency updates. I have one high-severity suggestion to pin the MathJax version to prevent potential future build failures due to unexpected updates.

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.

Thanks for fixing!

@vllm-bot vllm-bot merged commit 6dab89b into vllm-project:main Aug 27, 2025
12 checks passed
@hmellor hmellor deleted the docs-fix-math branch August 27, 2025 05:38
tc-mb pushed a commit to tc-mb/vllm that referenced this pull request Aug 27, 2025
epwalsh pushed a commit to epwalsh/vllm that referenced this pull request Aug 28, 2025
xiao-llm pushed a commit to xiao-llm/vllm that referenced this pull request Aug 28, 2025
zhewenl pushed a commit to zhewenl/vllm that referenced this pull request Aug 28, 2025
zhewenl pushed a commit to zhewenl/vllm that referenced this pull request Sep 3, 2025
FeiDaLI pushed a commit to FeiDaLI/vllm that referenced this pull request Sep 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/build documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants