Skip to content

[Doc] Fix broken cuda installation doc rendering #17654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 5, 2025

Conversation

Isotr0py
Copy link
Collaborator

@Isotr0py Isotr0py commented May 5, 2025

  • Seems that myst-parser can't render markdown headings with code inside a tab-item correctly after update:
    20250505213612

  • This PR tries to fix the rendering to keep the heading readable:
    20250505213627

Signed-off-by: Isotr0py <2037008807@qq.com>
Copy link

github-actions bot commented May 5, 2025

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@Isotr0py Isotr0py requested a review from DarkLight1337 May 5, 2025 13:40
@mergify mergify bot added the documentation Improvements or additions to documentation label May 5, 2025
@Isotr0py Isotr0py requested a review from hmellor May 5, 2025 13:41
@hmellor
Copy link
Member

hmellor commented May 5, 2025

Looks like this was working up until v0.8.5 https://docs.vllm.ai/en/v0.8.5_a/getting_started/installation/gpu.html

@hmellor
Copy link
Member

hmellor commented May 5, 2025

Could it be related to #17379?

@hmellor
Copy link
Member

hmellor commented May 5, 2025

Ok I've confirmed that that PR was the cause

@hmellor
Copy link
Member

hmellor commented May 5, 2025

@Isotr0py instead of updating the docs, can you please revert myst-parser to 3.0.1? That should resolve the issue

Signed-off-by: Isotr0py <2037008807@qq.com>
@mergify mergify bot added the ci/build label May 5, 2025
Signed-off-by: Isotr0py <2037008807@qq.com>
@hmellor hmellor enabled auto-merge (squash) May 5, 2025 16:14
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label May 5, 2025
@hmellor hmellor merged commit cc05b90 into vllm-project:main May 5, 2025
33 of 35 checks passed
wuisawesome pushed a commit to character-tech/vllm that referenced this pull request May 5, 2025
Signed-off-by: Isotr0py <2037008807@qq.com>
Signed-off-by: Alex <alexwu@character.ai>
@Isotr0py Isotr0py deleted the fix-install-doc branch May 6, 2025 05:59
RichardoMrMu pushed a commit to RichardoMrMu/vllm that referenced this pull request May 12, 2025
Signed-off-by: Isotr0py <2037008807@qq.com>
Signed-off-by: Mu Huai <tianbowen.tbw@antgroup.com>
mawong-amd pushed a commit to ROCm/vllm that referenced this pull request May 14, 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 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