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, 17:15 UTC
[doc] update doc (#15740)
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Reid committed
Mar 29, 2025 at 12:27 UTC
73aa7041bfee43581314e6f34e9a657137ecc092
1 file changed
+26
-3
docs/README.md
+26
-3
@@ -2,19 +2,42 @@
2
3
## Build the docs
4
5
+- Make sure in `docs` directory
6
+
7
+```bash
8
+cd docs
9
+```
10
+
11
+- Install the dependencies:
12
+
13
```bash
6
-# Install dependencies.
14
pip install -r ../requirements/docs.txt
15
+```
16
+
17
+- Clean the previous build (optional but recommended):
18
9
-# Build the docs.
19
+```bash
20
make clean
21
+```
22
+
23
+- Generate the HTML documentation:
24
+
25
+```bash
26
make html
27
```
28
29
## Open the docs with your browser
30
31
+- Serve the documentation locally:
32
+
33
```bash
34
python -m http.server -d build/html/
35
```
36
20
-Launch your browser and open localhost:8000.
37
+This will start a local server at http://localhost:8000. You can now open your browser and view the documentation.
38
+
39
+If port 8000 is already in use, you can specify a different port, for example:
40
+
41
+```bash
42
+python -m http.server 3000 -d build/html/
43
+```