Skip to content

[doc] small fix - mkdocs #18996

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

Merged
vllm-bot merged 2 commits into from
Jun 1, 2025
Merged

[doc] small fix - mkdocs #18996

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
629a74c
[doc] small fix - mkdocs
reidliu41 May 31, 2025
21331fc
highlight pkg name
reidliu41 Jun 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/contributing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,12 @@ Install MkDocs along with the [plugins](https://github.com/vllm-project/vllm/blo
pip install -r requirements/docs.txt
```

> **Note:** Ensure that your Python version is compatible with the plugins (e.g., mkdocs-awesome-nav requires Python 3.10+)
!!! note
Ensure that your Python version is compatible with the plugins (e.g., `mkdocs-awesome-nav` requires Python 3.10+)

#### Verify Installation

Confirm that MkDocs is correctly installed::
Confirm that MkDocs is correctly installed:

```bash
mkdocs --version
Expand Down