Skip to content

Commit 41b3a23

Browse files
authored
[Doc] Fix doc link url bug (vllm-project#11606)
Make sure the doc url like `xxxx.html` works as before - vLLM version: v0.23.0 - vLLM main: vllm-project/vllm@1f486d9 Signed-off-by: wangxiyuan <wangxiyuan1007@gmail.com>
1 parent 0d8b7ae commit 41b3a23

21 files changed

Lines changed: 79 additions & 44 deletions

.github/workflows/scripts/detect_po_changes.py

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ def _relative_to_source(path: Path) -> str:
208208
def _write_po_from_paragraphs(po_path: Path, rel: str, paragraphs: list[str], dry_run: bool = False) -> bool:
209209
"""Write a fresh .po file from extracted paragraphs, discarding any existing translations."""
210210
header = _po_header(str(rel))
211-
body_entries = "\n\n".join(f'msgid "{p.replace(chr(34), chr(92) + chr(34))}"\nmsgstr ""' for p in paragraphs)
211+
body_entries = "\n\n".join(_po_entry_block(p) for p in paragraphs)
212212
if dry_run:
213213
print(f" [DRY-RUN] Would force-regenerate: {po_path} ({len(paragraphs)} entries)")
214214
return True
@@ -218,6 +218,28 @@ def _write_po_from_paragraphs(po_path: Path, rel: str, paragraphs: list[str], dr
218218
return True
219219

220220

221+
def _po_entry_block(msgid: str) -> str:
222+
"""Build a valid PO entry block (msgid + msgstr) for *msgid*.
223+
224+
Multi-line msgid values are wrapped with empty-string continuation
225+
lines as required by the PO format. The final continuation line
226+
does NOT carry a trailing \\n.
227+
"""
228+
lines = msgid.split("\n")
229+
if len(lines) == 1:
230+
escaped = msgid.replace("\\", "\\\\").replace('"', '\\"')
231+
return f'msgid "{escaped}"\nmsgstr ""'
232+
parts = ['msgid ""']
233+
for i, line in enumerate(lines):
234+
escaped = line.replace("\\", "\\\\").replace('"', '\\"')
235+
if i < len(lines) - 1:
236+
parts.append(f'"{escaped}\\n"')
237+
else:
238+
parts.append(f'"{escaped}"')
239+
parts.append('msgstr ""')
240+
return "\n".join(parts)
241+
242+
221243
def process_file(source_path: Path, dry_run: bool = False, force: bool = False) -> bool:
222244
"""Create or update the .po file for *source_path*.
223245

.github/workflows/scripts/po_translate.py

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
3. Keep msgid lines COMPLETELY UNCHANGED — never modify source text.
5656
5757
--- WHAT TO PRESERVE ---
58-
4. All format specifiers: %s, %d, %f, {}, {{}}, {name}, etc.
58+
4. All format specifiers: %s, %d, %f, {{}}, {{{{}}}}, {{name}}, etc.
5959
5. All markdown syntax: **bold**, *italic*, `inline code`, ```code blocks```,
6060
[links](urls), ![images](urls), # headings, - lists, 1. ordered lists,
6161
> blockquotes, | tables, --- horizontal rules.
@@ -186,8 +186,20 @@ def _build_snippet(entries: list[POEntry]) -> str:
186186
"""Build a minimal PO content string containing only *entries*."""
187187
parts = []
188188
for entry in entries:
189-
escaped = entry.msgid.replace('"', '\\"')
190-
parts.append(f'msgid "{escaped}"\nmsgstr ""')
189+
lines = entry.msgid.split("\n")
190+
if len(lines) == 1:
191+
escaped = entry.msgid.replace("\\", "\\\\").replace('"', '\\"')
192+
parts.append(f'msgid "{escaped}"\nmsgstr ""')
193+
else:
194+
block = ['msgid ""']
195+
for i, line in enumerate(lines):
196+
escaped = line.replace("\\", "\\\\").replace('"', '\\"')
197+
if i < len(lines) - 1:
198+
block.append(f'"{escaped}\\n"')
199+
else:
200+
block.append(f'"{escaped}"')
201+
block.append('msgstr ""')
202+
parts.append("\n".join(block))
191203
return "\n\n".join(parts) + "\n"
192204

193205
@staticmethod

docs/source/tutorials/models/DeepSeek-R1.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Key Parameter Descriptions:
169169
- `--no-enable-prefix-caching` indicates that prefix caching is disabled. To enable it, remove this option.
170170
- If you use the w4a8 weight, more memory will be allocated to kvcache, and you can try to increase system throughput to achieve greater throughput.
171171

172-
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
172+
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
173173

174174
Service Verification:
175175

@@ -326,7 +326,7 @@ Key Parameter Descriptions:
326326
- `--headless`: indicates that this vLLM instance is not the master service node. Only set on non-master nodes (Node 1). The master node (Node 0) should NOT set this flag.
327327
- For single-node deployment, we recommend using `dp4 tp4` instead of `dp2 tp8`.
328328

329-
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
329+
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
330330

331331
Service Verification:
332332

@@ -441,4 +441,4 @@ This solution has been tested and demonstrates excellent performance.
441441

442442
## 10 FAQ
443443

444-
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/).
444+
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html).

docs/source/tutorials/models/DeepSeek-V3.1.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Key Parameter Descriptions:
181181
- `--no-enable-prefix-caching` indicates that prefix caching is disabled. To enable it, remove this option.
182182
- If you use the w4a8 weight, more memory will be allocated to kvcache, and you can try to increase system throughput to achieve greater throughput.
183183

184-
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
184+
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
185185

186186
Service Verification:
187187

@@ -355,7 +355,7 @@ Key Parameter Descriptions:
355355
- `--headless`: indicates that this vLLM instance is not the master service node. Only set on non-master nodes (Node 1). The master node (Node 0) should NOT set this flag.
356356
- For single-node deployment, we recommend using `dp4 tp4` instead of `dp2 tp8`.
357357

358-
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
358+
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
359359

360360
Service Verification:
361361

@@ -844,7 +844,7 @@ The proxy returns HTTP 200 OK. The JSON response contains the `choices` field wi
844844
}
845845
```
846846
847-
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
847+
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
848848
849849
## 6 Functional Verification
850850
@@ -965,4 +965,4 @@ Please refer to the [Feature Guide](../../user_guide/support_matrix/feature_matr
965965
966966
## 10 FAQ
967967
968-
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/).
968+
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html).

docs/source/tutorials/models/DeepSeek-V4-Flash.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ Key Parameter Descriptions:
235235
- `--async-scheduling` enables asynchronous scheduling to overlap CPU scheduling with NPU computation.
236236
- `VLLM_ASCEND_ENABLE_FLASHCOMM1=1` enables the FlashComm communication optimization.
237237

238-
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
238+
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
239239

240240
Service Verification:
241241

@@ -839,7 +839,7 @@ Deployment Verification:
839839

840840
After the PD separation service is fully started, send a request through the proxy port on the prefill master node to verify that Prefill and Decode nodes are working correctly together. Refer to [Prefill-Decode Disaggregation (Deepseek)](../features/pd_disaggregation_mooncake_multi_node.md) for the proxy verification method.
841841

842-
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
842+
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
843843

844844
#### 5.2.3 Ultra-Long Sequence Deployment
845845

@@ -940,4 +940,4 @@ Please refer to the [Feature Guide](../../user_guide/support_matrix/feature_matr
940940

941941
## 10 FAQ
942942

943-
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/); this chapter only covers model-specific issues.
943+
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html); this chapter only covers model-specific issues.

docs/source/tutorials/models/DeepSeek-V4-Pro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ Key Parameter Descriptions:
422422
- `--async-scheduling` enables asynchronous scheduling to overlap CPU scheduling with NPU computation.
423423
- `VLLM_ASCEND_ENABLE_FLASHCOMM1=1` enables the FlashComm communication optimization.
424424

425-
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
425+
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
426426

427427
Service Verification:
428428

@@ -1169,7 +1169,7 @@ Deployment Verification:
11691169

11701170
After the PD separation service is fully started, send a request through the proxy port on the prefill master node to verify that Prefill and Decode nodes are working correctly together. Refer to [Prefill-Decode Disaggregation (Deepseek)](../features/pd_disaggregation_mooncake_multi_node.md) for the proxy verification method.
11711171

1172-
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
1172+
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
11731173

11741174
## 6 Functional Verification
11751175

@@ -1265,4 +1265,4 @@ Please refer to the [Feature Guide](../../user_guide/support_matrix/feature_matr
12651265

12661266
## 10 FAQ
12671267

1268-
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/); this chapter only covers model-specific issues.
1268+
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html); this chapter only covers model-specific issues.

docs/source/tutorials/models/DeepSeekOCR2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Please refer to the [Feature Guide](../../user_guide/support_matrix/feature_matr
236236

237237
## 10 FAQ
238238

239-
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/).
239+
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html).
240240

241241
- **Q: Startup fails with HCCL port conflicts (address already bound). What should I do?**
242242

docs/source/tutorials/models/Kimi-K2-Thinking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ Please refer to the [Feature Guide](../../user_guide/support_matrix/feature_matr
369369

370370
## 10 FAQ
371371

372-
> For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/); this chapter only covers model-specific issues.
372+
> For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html); this chapter only covers model-specific issues.
373373
374374
- **Q: API returns `{"error":"Model not found"}` or `404` when requesting with `model: "Kimi-K2-Thinking"`?**
375375

docs/source/tutorials/models/Kimi-K2.5.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Key Parameter Descriptions:
179179
- `--mm-encoder-tp-mode` indicates how to optimize multi-modal encoder inference using tensor parallelism (TP). If you want to test the multimodal inputs, we recommend using `data`.
180180
- If you use the w4a8 weight, more memory will be allocated to kvcache, and you can try to increase system throughput to achieve greater throughput.
181181

182-
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
182+
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
183183

184184
Service Verification:
185185

@@ -383,7 +383,7 @@ Key Parameter Descriptions:
383383
- `--headless`: indicates that this vLLM instance is not the master service node. Only set on non-master nodes (Node 1). The master node (Node 0) should NOT set this flag.
384384
- For single-node deployment, we recommend using `dp4 tp4` instead of `dp2 tp8`.
385385

386-
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
386+
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
387387

388388
Service Verification:
389389

@@ -903,7 +903,7 @@ The proxy returns HTTP 200 OK. The JSON response contains the `choices` field wi
903903
}
904904
```
905905
906-
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
906+
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
907907
908908
## 6 Functional Verification
909909
@@ -1040,7 +1040,7 @@ Please refer to the [Feature Guide](../../user_guide/support_matrix/feature_matr
10401040
10411041
## 10 FAQ
10421042
1043-
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/); this chapter only covers model-specific issues.
1043+
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html); this chapter only covers model-specific issues.
10441044
10451045
- **Q: What is the recommended TP/DP configuration for single-node deployment?**
10461046

docs/source/tutorials/models/Kimi-K2.6.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Key Parameter Descriptions:
183183
- `--mm-encoder-tp-mode` indicates how to optimize multi-modal encoder inference using tensor parallelism (TP). If you want to test the multimodal inputs, we recommend using `data`.
184184
- If you use the w4a8 weight, more memory will be allocated to kvcache, and you can try to increase system throughput to achieve greater throughput.
185185

186-
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
186+
Common Issues Tip: If you encounter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
187187

188188
Service Verification:
189189

@@ -724,7 +724,7 @@ The proxy returns HTTP 200 OK. The JSON response contains the `choices` field wi
724724
}
725725
```
726726
727-
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/) for troubleshooting.
727+
Common Issues Tip: If you encounter issues with PD separation deployment, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html) for troubleshooting.
728728
729729
## 6 Functional Verification
730730
@@ -867,7 +867,7 @@ Please refer to the [Feature Guide](../../user_guide/support_matrix/feature_matr
867867
868868
## 10 FAQ
869869
870-
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs/); this chapter only covers model-specific issues.
870+
For common environment, installation, and general parameter issues, please refer to the [Public FAQ](https://docs.vllm.ai/projects/ascend/en/latest/faqs.html); this chapter only covers model-specific issues.
871871
872872
- **Q: What transformer version is required for tool_calls feature?**
873873

0 commit comments

Comments
 (0)