Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Doc] Convert docs to use colon fences #12471

Merged
merged 8 commits into from
Jan 29, 2025
Merged

[Doc] Convert docs to use colon fences #12471

merged 8 commits into from
Jan 29, 2025

Conversation

hmellor
Copy link
Member

@hmellor hmellor commented Jan 27, 2025

Converts docs to use colon fences instead of backtick fences, as requested in https://vllm-dev.slack.com/archives/C087WACBTHC/p1737623935138279

@hmellor
First pass
c8a2dc0 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Fix pragma locations
dd6a245 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Fix eval-rst not being regocnised
cb31f27 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Fix tab-set nesting
d3ead98 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Sort docs requirements
df4f2e9 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@github-actions GitHub Actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.
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 do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Jan 27, 2025
@DarkLight1337 DarkLight1337 changed the title Convert docs to use colon fences Doc] Convert docs to use colon fences Jan 27, 2025
@DarkLight1337 DarkLight1337 changed the title Doc] Convert docs to use colon fences [Doc] Convert docs to use colon fences Jan 27, 2025
@hmellor
Remove unused sphinx-autodoc2
32fcd34 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@DarkLight1337 DarkLight1337 self-assigned this Jan 27, 2025
@hmellor
Fix MD004
8f21175 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
DarkLight1337
DarkLight1337 approved these changes Jan 27, 2025
View reviewed changes
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.

I've scanned through a couple of pages and they all look good to me, thanks for picking up this task!

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) January 27, 2025 12:59
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jan 27, 2025
@DarkLight1337
Copy link
Member

Please merge from main to fix the CI failures. (preferably after #12069 to avoid merge conflict)

@hmellor
Merge branch 'main' into colon-fence-docs
95ffbcd 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@DarkLight1337
Copy link
Member

Merging this first

@DarkLight1337 DarkLight1337 merged commit dd6a3a0 into vllm-project:main Jan 29, 2025
27 checks passed
@hmellor hmellor deleted the colon-fence-docs branch January 29, 2025 07:59
rasmith pushed a commit to rasmith/vllm that referenced this pull request Jan 30, 2025
@hmellor @rasmith
[Doc] Convert docs to use colon fences (vllm-project#12471)
90f2a75 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Isotr0py pushed a commit to Isotr0py/vllm that referenced this pull request Feb 2, 2025
@hmellor @Isotr0py
[Doc] Convert docs to use colon fences (vllm-project#12471)
5c5be63 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Isotr0py <2037008807@qq.com>
NickLucche pushed a commit to NickLucche/vllm that referenced this pull request Feb 7, 2025
@hmellor @NickLucche
[Doc] Convert docs to use colon fences (vllm-project#12471)
fe40d9a 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
ShangmingCai pushed a commit to ShangmingCai/vllm that referenced this pull request Feb 10, 2025
@hmellor @ShangmingCai
[Doc] Convert docs to use colon fences (vllm-project#12471)
2db679e 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
GWS0428 pushed a commit to GWS0428/VARserve that referenced this pull request Feb 12, 2025
@hmellor @GWS0428
[Doc] Convert docs to use colon fences (vllm-project#12471)
c1feb6e 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
panf2333 pushed a commit to yottalabsai/vllm that referenced this pull request Feb 18, 2025
@hmellor @panf2333
[Doc] Convert docs to use colon fences (vllm-project#12471)
515d357 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
kerthcet pushed a commit to kerthcet/vllm that referenced this pull request Feb 21, 2025
@hmellor @kerthcet
[Doc] Convert docs to use colon fences (vllm-project#12471)
dbe5b1f 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
lk-chen pushed a commit to lk-chen/vllm that referenced this pull request Mar 5, 2025
@hmellor @lk-chen
[Doc] Convert docs to use colon fences (vllm-project#12471)
dfd4310 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Linkun Chen <github@lkchen.net>
Said-Akbar pushed a commit to Said-Akbar/vllm-rocm that referenced this pull request Mar 7, 2025
@hmellor @Said-Akbar
[Doc] Convert docs to use colon fences (vllm-project#12471)
d384e22 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: saeediy <saidakbarp@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mgoin mgoin mgoin approved these changes

@DarkLight1337 DarkLight1337 DarkLight1337 approved these changes

Assignees

@DarkLight1337 DarkLight1337

Labels
documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@hmellor @DarkLight1337 @mgoin