-
-
Notifications
You must be signed in to change notification settings - Fork 15.1k
[doc] add mkdocs doc #18930
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
[doc] add mkdocs doc #18930
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -29,20 +29,67 @@ See <gh-file:LICENSE>. | |||||
| Depending on the kind of development you'd like to do (e.g. Python, CUDA), you can choose to build vLLM with or without compilation. | ||||||
| Check out the [building from source][build-from-source] documentation for details. | ||||||
|
|
||||||
| ### Building the docs | ||||||
| ### Building the docs with MkDocs | ||||||
|
|
||||||
| Install the dependencies: | ||||||
| #### Introduction to MkDocs | ||||||
|
|
||||||
| [MkDocs](https://github.com/mkdocs/mkdocs) is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. | ||||||
|
|
||||||
| #### Install MkDocs and Plugins | ||||||
|
|
||||||
| Install MkDocs along with the [plugins](https://github.com/vllm-project/vllm/blob/main/mkdocs.yaml) used in the vLLM documentation, as well as required dependencies: | ||||||
|
|
||||||
| ```bash | ||||||
| pip install -r requirements/docs.txt | ||||||
| ``` | ||||||
|
|
||||||
| Start the autoreloading MkDocs server: | ||||||
| > **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:: | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. thanks, updated in #18996 |
||||||
|
|
||||||
| ```bash | ||||||
| mkdocs --version | ||||||
| ``` | ||||||
|
|
||||||
| Example output: | ||||||
|
|
||||||
| ```console | ||||||
| mkdocs, version 1.6.1 from /opt/miniconda3/envs/mkdoc/lib/python3.9/site-packages/mkdocs (Python 3.9) | ||||||
| ``` | ||||||
|
|
||||||
| #### Clone the `vLLM` repository | ||||||
|
|
||||||
| ```bash | ||||||
| git clone https://github.com/vllm-project/vllm.git | ||||||
| cd vllm | ||||||
| ``` | ||||||
|
|
||||||
| #### Start the Development Server | ||||||
|
|
||||||
| MkDocs comes with a built-in dev-server that lets you preview your documentation as you work on it. Make sure you're in the same directory as the `mkdocs.yml` configuration file, and then start the server by running the `mkdocs serve` command: | ||||||
|
|
||||||
| ```bash | ||||||
| mkdocs serve | ||||||
| ``` | ||||||
|
|
||||||
| Example output: | ||||||
|
|
||||||
| ```console | ||||||
| INFO - Documentation built in 106.83 seconds | ||||||
| INFO - [22:02:02] Watching paths for changes: 'docs', 'mkdocs.yaml' | ||||||
| INFO - [22:02:02] Serving on http://127.0.0.1:8000/ | ||||||
| ``` | ||||||
|
|
||||||
| #### View in Your Browser | ||||||
|
|
||||||
| Open up [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your browser to see a live preview:. | ||||||
|
|
||||||
| #### Learn More | ||||||
|
|
||||||
| For additional features and advanced configurations, refer to the official [MkDocs Documentation](https://www.mkdocs.org/). | ||||||
|
|
||||||
| ## Testing | ||||||
|
|
||||||
| ```bash | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could use an admonition here