跳转至

vLLM Ascend 插件文档

在线文档:https://docs.vllm.ai/projects/ascend

构建文档

文档使用 MkDocs 和 Material for MkDocs 主题。

前提条件

请从仓库根目录运行本指南中的所有命令。建议使用虚拟环境,但不是必需的。

# Install documentation dependencies.
python -m pip install -r docs/requirements-docs.txt

构建并运行(英文)

# Serve docs locally with live reload.
make -f docs/Makefile serve
# Open http://127.0.0.1:8000/projects/ascend/en/latest/

# Or build to site/.
make -f docs/Makefile build

# Serve the built static files.
python -m http.server -d site/
# Open http://127.0.0.1:8000/

构建并运行(中文)

中文文档由 docs/source/locale/zh_CN/LC_MESSAGES/ 中的 .po 翻译文件生成。中文的 serve 和 build 目标会自动生成翻译后的 Markdown 文件。

# Serve Chinese docs locally.
make -f docs/Makefile serve-zh

# Or build to site/zh/.
make -f docs/Makefile build-zh

# Or only generate Chinese Markdown files without serving or building.
make -f docs/Makefile gen-zh

从 Sphinx 迁移

如果你正在从旧的 Sphinx/MyST 格式迁移 Markdown 文件,转换遵循以下规则:

  • MyST toctree → 移除(导航位于 mkdocs.yml)
  • MyST admonitions → MkDocs admonition 语法
  • MyST tab-set/tab-item → MkDocs Material 选项卡语法
  • MyST code-block → 标准围栏代码块
  • MyST 变量替换 |var| → {{ var }} 宏语法

版本变量

版本变量(例如 v0.23.0)定义在 mkdocs.yml 的 extra 部分,并在构建时由 mkdocs-macros 插件替换。

要更新版本,请编辑 mkdocs.yml 中的 extra 部分。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 vl/vllm-ascend