A high-throughput and memory-efficient inference and serving engine for LLMs
Mirrored from https://github.com/tduncan-lum/Nvidia-Optimization-Stack---VLLM.git
Synced Nov 15, 07:15 UTC
[doc] add mkdocs doc (#18930)
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Reid committed
May 30, 2025 at 15:58 UTC
8f8900cee9121572d27463b7d8223fa6ef76e0ef
1 file changed
+50
-3
docs/contributing/README.md
+50
-3
@@ -29,20 +29,67 @@ See <gh-file:LICENSE>.
29
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.
30
Check out the [building from source][build-from-source] documentation for details.
31
32
-### Building the docs
32
+### Building the docs with MkDocs
33
34
-Install the dependencies:
34
+#### Introduction to MkDocs
35
+
36
+[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.
37
+
38
+#### Install MkDocs and Plugins
39
+
40
+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:
41
42
```bash
43
pip install -r requirements/docs.txt
44
```
45
40
-Start the autoreloading MkDocs server:
46
+> **Note:** Ensure that your Python version is compatible with the plugins (e.g., mkdocs-awesome-nav requires Python 3.10+)
47
+
48
+#### Verify Installation
49
+
50
+Confirm that MkDocs is correctly installed::
51
+
52
+```bash
53
+mkdocs --version
54
+```
55
+
56
+Example output:
57
+
58
+```console
59
+mkdocs, version 1.6.1 from /opt/miniconda3/envs/mkdoc/lib/python3.9/site-packages/mkdocs (Python 3.9)
60
+```
61
+
62
+#### Clone the `vLLM` repository
63
+
64
+```bash
65
+git clone https://github.com/vllm-project/vllm.git
66
+cd vllm
67
+```
68
+
69
+#### Start the Development Server
70
+
71
+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:
72
73
```bash
74
mkdocs serve
75
```
76
77
+Example output:
78
+
79
+```console
80
+INFO - Documentation built in 106.83 seconds
81
+INFO - [22:02:02] Watching paths for changes: 'docs', 'mkdocs.yaml'
82
+INFO - [22:02:02] Serving on http://127.0.0.1:8000/
83
+```
84
+
85
+#### View in Your Browser
86
+
87
+Open up [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your browser to see a live preview:.
88
+
89
+#### Learn More
90
+
91
+For additional features and advanced configurations, refer to the official [MkDocs Documentation](https://www.mkdocs.org/).
92
+
93
## Testing
94
95
```bash