Skip to content

Commit 008c0ae

Browse files
simon-mojimpang
authored andcommitted
[CI] Ensure documentation build is checked in CI (vllm-project#2842)
1 parent a808486 commit 008c0ae

File tree

5 files changed

+14
-1
lines changed

5 files changed

+14
-1
lines changed

.buildkite/test-pipeline.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,10 @@ steps:
4949
commands:
5050
- pip install aiohttp
5151
- bash run-benchmarks.sh
52+
53+
- label: Documentation Build
54+
working_dir: "/vllm-workspace/docs"
55+
no_gpu: True
56+
commands:
57+
- pip install -r requirements-docs.txt
58+
- SPHINXOPTS=\"-W\" make html

.buildkite/test-template.j2

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,15 @@ steps:
3535
- image: "{{ docker_image }}"
3636
command: ["bash"]
3737
args:
38-
- "-c"
38+
- '-c'
3939
- "'cd {{ (step.working_dir or default_working_dir) | safe }} && {{ step.command or (step.commands | join(' && ')) | safe }}'"
40+
{% if not step.no_gpu %}
4041
resources:
4142
requests:
4243
nvidia.com/gpu: "{{ step.num_gpus or default_num_gpu }}"
4344
limits:
4445
nvidia.com/gpu: "{{ step.num_gpus or default_num_gpu }}"
46+
{% endif %}
4547
env:
4648
- name: HF_TOKEN
4749
valueFrom:

docs/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,5 @@ def add_line(self, line: str, source: str, *lineno: int) -> None:
9494

9595

9696
autodoc.ClassDocumenter = MockedClassDocumenter
97+
98+
navigation_with_keys = False

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ Documentation
8989
:caption: Quantization
9090

9191
quantization/auto_awq
92+
quantization/fp8_e5m2_kv_cache
9293

9394
.. toctree::
9495
:maxdepth: 2

docs/source/quantization/fp8_e5m2_kv_cache.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ The FP8 data format retains 2~3 mantissa bits and can convert float/fp16/bflaot1
99
Here is an example of how to enable this feature:
1010

1111
.. code-block:: python
12+
1213
from vllm import LLM, SamplingParams
1314
# Sample prompts.
1415
prompts = [

0 commit comments

Comments
 (0)