Skip to content

Commit bc2d447

Browse files
authored
[Docs] Make installation URLs nicer (vllm-project#14556)
Signed-off-by: Harry Mellor <[email protected]>
1 parent 3b352a2 commit bc2d447

File tree

8 files changed

+75
-75
lines changed

8 files changed

+75
-75
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ pip install vllm
9191
```
9292

9393
Visit our [documentation](https://docs.vllm.ai/en/latest/) to learn more.
94-
- [Installation](https://docs.vllm.ai/en/latest/getting_started/installation/index.html)
94+
- [Installation](https://docs.vllm.ai/en/latest/getting_started/installation.html)
9595
- [Quickstart](https://docs.vllm.ai/en/latest/getting_started/quickstart.html)
9696
- [List of Supported Models](https://docs.vllm.ai/en/latest/models/supported_models.html)
9797

docs/source/getting_started/installation/index.md docs/source/getting_started/installation.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ vLLM supports the following hardware platforms:
88
:maxdepth: 1
99
:hidden:
1010

11-
gpu/index
12-
cpu/index
13-
ai_accelerator/index
11+
installation/gpu
12+
installation/cpu
13+
installation/ai_accelerator
1414
:::
1515

16-
- <project:gpu/index.md>
16+
- <project:installation/gpu.md>
1717
- NVIDIA CUDA
1818
- AMD ROCm
1919
- Intel XPU
20-
- <project:cpu/index.md>
20+
- <project:installation/cpu.md>
2121
- Intel/AMD x86
2222
- ARM AArch64
2323
- Apple silicon
24-
- <project:ai_accelerator/index.md>
24+
- <project:installation/ai_accelerator.md>
2525
- Google TPU
2626
- Intel Gaudi
2727
- AWS Neuron

docs/source/getting_started/installation/ai_accelerator/index.md docs/source/getting_started/installation/ai_accelerator.md

+32-32
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
99
:selected:
1010
:sync: tpu
1111

12-
:::{include} tpu.inc.md
12+
:::{include} ai_accelerator/tpu.inc.md
1313
:start-after: "# Installation"
1414
:end-before: "## Requirements"
1515
:::
@@ -19,7 +19,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
1919
::::{tab-item} Intel Gaudi
2020
:sync: hpu-gaudi
2121

22-
:::{include} hpu-gaudi.inc.md
22+
:::{include} ai_accelerator/hpu-gaudi.inc.md
2323
:start-after: "# Installation"
2424
:end-before: "## Requirements"
2525
:::
@@ -29,7 +29,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
2929
::::{tab-item} AWS Neuron
3030
:sync: neuron
3131

32-
:::{include} neuron.inc.md
32+
:::{include} ai_accelerator/neuron.inc.md
3333
:start-after: "# Installation"
3434
:end-before: "## Requirements"
3535
:::
@@ -39,7 +39,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
3939
::::{tab-item} OpenVINO
4040
:sync: openvino
4141

42-
:::{include} openvino.inc.md
42+
:::{include} ai_accelerator/openvino.inc.md
4343
:start-after: "# Installation"
4444
:end-before: "## Requirements"
4545
:::
@@ -56,7 +56,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
5656
::::{tab-item} Google TPU
5757
:sync: tpu
5858

59-
:::{include} tpu.inc.md
59+
:::{include} ai_accelerator/tpu.inc.md
6060
:start-after: "## Requirements"
6161
:end-before: "## Configure a new environment"
6262
:::
@@ -66,7 +66,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
6666
::::{tab-item} Intel Gaudi
6767
:sync: hpu-gaudi
6868

69-
:::{include} hpu-gaudi.inc.md
69+
:::{include} ai_accelerator/hpu-gaudi.inc.md
7070
:start-after: "## Requirements"
7171
:end-before: "## Configure a new environment"
7272
:::
@@ -76,7 +76,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
7676
::::{tab-item} AWS Neuron
7777
:sync: neuron
7878

79-
:::{include} neuron.inc.md
79+
:::{include} ai_accelerator/neuron.inc.md
8080
:start-after: "## Requirements"
8181
:end-before: "## Configure a new environment"
8282
:::
@@ -86,7 +86,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
8686
::::{tab-item} OpenVINO
8787
:sync: openvino
8888

89-
:::{include} openvino.inc.md
89+
:::{include} ai_accelerator/openvino.inc.md
9090
:start-after: "## Requirements"
9191
:end-before: "## Set up using Python"
9292
:::
@@ -103,7 +103,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
103103
::::{tab-item} Google TPU
104104
:sync: tpu
105105

106-
:::{include} tpu.inc.md
106+
:::{include} ai_accelerator/tpu.inc.md
107107
:start-after: "## Configure a new environment"
108108
:end-before: "## Set up using Python"
109109
:::
@@ -113,7 +113,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
113113
::::{tab-item} Intel Gaudi
114114
:sync: hpu-gaudi
115115

116-
:::{include} hpu-gaudi.inc.md
116+
:::{include} ai_accelerator/hpu-gaudi.inc.md
117117
:start-after: "## Configure a new environment"
118118
:end-before: "## Set up using Python"
119119
:::
@@ -123,7 +123,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
123123
::::{tab-item} AWS Neuron
124124
:sync: neuron
125125

126-
:::{include} neuron.inc.md
126+
:::{include} ai_accelerator/neuron.inc.md
127127
:start-after: "## Configure a new environment"
128128
:end-before: "## Set up using Python"
129129
:::
@@ -133,7 +133,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
133133
::::{tab-item} OpenVINO
134134
:sync: openvino
135135

136-
:::{include} ../python_env_setup.inc.md
136+
:::{include} python_env_setup.inc.md
137137
:::
138138

139139
::::
@@ -150,7 +150,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
150150
::::{tab-item} Google TPU
151151
:sync: tpu
152152

153-
:::{include} tpu.inc.md
153+
:::{include} ai_accelerator/tpu.inc.md
154154
:start-after: "### Pre-built wheels"
155155
:end-before: "### Build wheel from source"
156156
:::
@@ -160,7 +160,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
160160
::::{tab-item} Intel Gaudi
161161
:sync: hpu-gaudi
162162

163-
:::{include} hpu-gaudi.inc.md
163+
:::{include} ai_accelerator/hpu-gaudi.inc.md
164164
:start-after: "### Pre-built wheels"
165165
:end-before: "### Build wheel from source"
166166
:::
@@ -170,7 +170,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
170170
::::{tab-item} AWS Neuron
171171
:sync: neuron
172172

173-
:::{include} neuron.inc.md
173+
:::{include} ai_accelerator/neuron.inc.md
174174
:start-after: "### Pre-built wheels"
175175
:end-before: "### Build wheel from source"
176176
:::
@@ -180,7 +180,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
180180
::::{tab-item} OpenVINO
181181
:sync: openvino
182182

183-
:::{include} openvino.inc.md
183+
:::{include} ai_accelerator/openvino.inc.md
184184
:start-after: "### Pre-built wheels"
185185
:end-before: "### Build wheel from source"
186186
:::
@@ -197,7 +197,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
197197
::::{tab-item} Google TPU
198198
:sync: tpu
199199

200-
:::{include} tpu.inc.md
200+
:::{include} ai_accelerator/tpu.inc.md
201201
:start-after: "### Build wheel from source"
202202
:end-before: "## Set up using Docker"
203203
:::
@@ -207,7 +207,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
207207
::::{tab-item} Intel Gaudi
208208
:sync: hpu-gaudi
209209

210-
:::{include} hpu-gaudi.inc.md
210+
:::{include} ai_accelerator/hpu-gaudi.inc.md
211211
:start-after: "### Build wheel from source"
212212
:end-before: "## Set up using Docker"
213213
:::
@@ -217,7 +217,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
217217
::::{tab-item} AWS Neuron
218218
:sync: neuron
219219

220-
:::{include} neuron.inc.md
220+
:::{include} ai_accelerator/neuron.inc.md
221221
:start-after: "### Build wheel from source"
222222
:end-before: "## Set up using Docker"
223223
:::
@@ -227,7 +227,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
227227
::::{tab-item} OpenVINO
228228
:sync: openvino
229229

230-
:::{include} openvino.inc.md
230+
:::{include} ai_accelerator/openvino.inc.md
231231
:start-after: "### Build wheel from source"
232232
:end-before: "## Set up using Docker"
233233
:::
@@ -246,7 +246,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
246246
::::{tab-item} Google TPU
247247
:sync: tpu
248248

249-
:::{include} tpu.inc.md
249+
:::{include} ai_accelerator/tpu.inc.md
250250
:start-after: "### Pre-built images"
251251
:end-before: "### Build image from source"
252252
:::
@@ -256,7 +256,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
256256
::::{tab-item} Intel Gaudi
257257
:sync: hpu-gaudi
258258

259-
:::{include} hpu-gaudi.inc.md
259+
:::{include} ai_accelerator/hpu-gaudi.inc.md
260260
:start-after: "### Pre-built images"
261261
:end-before: "### Build image from source"
262262
:::
@@ -266,7 +266,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
266266
::::{tab-item} AWS Neuron
267267
:sync: neuron
268268

269-
:::{include} neuron.inc.md
269+
:::{include} ai_accelerator/neuron.inc.md
270270
:start-after: "### Pre-built images"
271271
:end-before: "### Build image from source"
272272
:::
@@ -276,7 +276,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
276276
::::{tab-item} OpenVINO
277277
:sync: openvino
278278

279-
:::{include} openvino.inc.md
279+
:::{include} ai_accelerator/openvino.inc.md
280280
:start-after: "### Pre-built images"
281281
:end-before: "### Build image from source"
282282
:::
@@ -293,7 +293,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
293293
::::{tab-item} Google TPU
294294
:sync: tpu
295295

296-
:::{include} tpu.inc.md
296+
:::{include} ai_accelerator/tpu.inc.md
297297
:start-after: "### Build image from source"
298298
:end-before: "## Extra information"
299299
:::
@@ -303,7 +303,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
303303
::::{tab-item} Intel Gaudi
304304
:sync: hpu-gaudi
305305

306-
:::{include} hpu-gaudi.inc.md
306+
:::{include} ai_accelerator/hpu-gaudi.inc.md
307307
:start-after: "### Build image from source"
308308
:end-before: "## Extra information"
309309
:::
@@ -313,7 +313,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
313313
::::{tab-item} AWS Neuron
314314
:sync: neuron
315315

316-
:::{include} neuron.inc.md
316+
:::{include} ai_accelerator/neuron.inc.md
317317
:start-after: "### Build image from source"
318318
:end-before: "## Extra information"
319319
:::
@@ -323,7 +323,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
323323
::::{tab-item} OpenVINO
324324
:sync: openvino
325325

326-
:::{include} openvino.inc.md
326+
:::{include} ai_accelerator/openvino.inc.md
327327
:start-after: "### Build image from source"
328328
:end-before: "## Extra information"
329329
:::
@@ -340,7 +340,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
340340
::::{tab-item} Google TPU
341341
:sync: tpu
342342

343-
:::{include} tpu.inc.md
343+
:::{include} ai_accelerator/tpu.inc.md
344344
:start-after: "## Extra information"
345345
:::
346346

@@ -349,7 +349,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
349349
::::{tab-item} Intel Gaudi
350350
:sync: hpu-gaudi
351351

352-
:::{include} hpu-gaudi.inc.md
352+
:::{include} ai_accelerator/hpu-gaudi.inc.md
353353
:start-after: "## Extra information"
354354
:::
355355

@@ -358,7 +358,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
358358
::::{tab-item} AWS Neuron
359359
:sync: neuron
360360

361-
:::{include} neuron.inc.md
361+
:::{include} ai_accelerator/neuron.inc.md
362362
:start-after: "## Extra information"
363363
:::
364364

@@ -367,7 +367,7 @@ vLLM is a Python library that supports the following AI accelerators. Select you
367367
::::{tab-item} OpenVINO
368368
:sync: openvino
369369

370-
:::{include} openvino.inc.md
370+
:::{include} ai_accelerator/openvino.inc.md
371371
:start-after: "## Extra information"
372372
:::
373373

0 commit comments

Comments
 (0)