README.md 684 Bytes
Newer Older
Woosuk Kwon's avatar
Woosuk Kwon committed
1
# vLLM documents
Woosuk Kwon's avatar
Woosuk Kwon committed
2
3
4

## Build the docs

Reid's avatar
Reid committed
5
6
7
8
9
10
11
12
- Make sure in `docs` directory

```bash
cd docs
```

- Install the dependencies:

Woosuk Kwon's avatar
Woosuk Kwon committed
13
```bash
14
pip install -r ../requirements/docs.txt
Reid's avatar
Reid committed
15
16
17
```

- Clean the previous build (optional but recommended):
Woosuk Kwon's avatar
Woosuk Kwon committed
18

Reid's avatar
Reid committed
19
```bash
Woosuk Kwon's avatar
Woosuk Kwon committed
20
make clean
Reid's avatar
Reid committed
21
22
23
24
25
```

- Generate the HTML documentation:

```bash
Woosuk Kwon's avatar
Woosuk Kwon committed
26
27
28
make html
```

Bayang's avatar
Bayang committed
29
## Open the docs with your browser
Woosuk Kwon's avatar
Woosuk Kwon committed
30

Reid's avatar
Reid committed
31
32
- Serve the documentation locally:

Woosuk Kwon's avatar
Woosuk Kwon committed
33
```bash
Woosuk Kwon's avatar
Woosuk Kwon committed
34
python -m http.server -d build/html/
Woosuk Kwon's avatar
Woosuk Kwon committed
35
```
36

Reid's avatar
Reid committed
37
38
39
40
41
42
43
This will start a local server at http://localhost:8000. You can now open your browser and view the documentation.

If port 8000 is already in use, you can specify a different port, for example:

```bash
python -m http.server 3000 -d build/html/
```