xc-llm-ascend/docs/README.md

# vLLM Ascend Plugin documents

Live doc: <https://docs.vllm.ai/projects/ascend>

## Build the docs

```bash
# Install dependencies.
pip install -r requirements-docs.txt

# Build the docs.
make clean
make html

# Build the docs with translation
make intl

# Open the docs with your browser
python -m http.server -d _build/html/
```

Launch your browser and open:

- English version: <http://localhost:8000>
- Chinese version: <http://localhost:8000/zh_CN>
[Doc] Add sphinx build for vllm-ascend (#55) ### What this PR does / why we need it? This patch enables the doc build for vllm-ascend - Add sphinx build for vllm-ascend - Enable readthedocs for vllm-ascend - Fix CI: - exclude vllm-empty/tests/mistral_tool_use to skip `You need to agree to share your contact information to access this model` which introduce in https://github.com/vllm-project/vllm/commit/314cfade02b28d50349c4df1a7ea0bbdaef589f1 - Install test req to fix https://github.com/vllm-project/vllm-ascend/actions/runs/13304112758/job/37151690770: ``` vllm-empty/tests/mistral_tool_use/conftest.py:4: in <module> import pytest_asyncio E ModuleNotFoundError: No module named 'pytest_asyncio' ``` - exclude docs PR ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? 1. test locally: ```bash # Install dependencies. pip install -r requirements-docs.txt # Build the docs and preview make clean; make html; python -m http.server -d build/html/ ``` Launch browser and open http://localhost:8000/. 2. CI passed with preview: https://vllm-ascend--55.org.readthedocs.build/en/55/ Signed-off-by: Yikun Jiang <yikunkero@gmail.com> 2025-02-13 18:44:17 +08:00			`# vLLM Ascend Plugin documents`

[Lint]Style: reformat markdown files via markdownlint (#5884) ### What this PR does / why we need it? reformat markdown files via markdownlint - vLLM version: v0.13.0 - vLLM main: https://github.com/vllm-project/vllm/commit/bde38c11df0ea066a740efe9b77fff5418be45df --------- Signed-off-by: root <root@LAPTOP-VQKDDVMG.localdomain> Signed-off-by: MrZ20 <2609716663@qq.com> Co-authored-by: root <root@LAPTOP-VQKDDVMG.localdomain> 2026-01-15 09:06:01 +08:00			`Live doc: <https://docs.vllm.ai/projects/ascend>`
[Docs] Add dynamic version in docs (#90) ### What this PR does / why we need it? Add dynamic version in docs ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? Preview: https://vllm-ascend--90.org.readthedocs.build/en/90/ Signed-off-by: Yikun Jiang <yikunkero@gmail.com> 2025-02-19 08:57:27 +08:00
[Doc] Add sphinx build for vllm-ascend (#55) ### What this PR does / why we need it? This patch enables the doc build for vllm-ascend - Add sphinx build for vllm-ascend - Enable readthedocs for vllm-ascend - Fix CI: - exclude vllm-empty/tests/mistral_tool_use to skip `You need to agree to share your contact information to access this model` which introduce in https://github.com/vllm-project/vllm/commit/314cfade02b28d50349c4df1a7ea0bbdaef589f1 - Install test req to fix https://github.com/vllm-project/vllm-ascend/actions/runs/13304112758/job/37151690770: ``` vllm-empty/tests/mistral_tool_use/conftest.py:4: in <module> import pytest_asyncio E ModuleNotFoundError: No module named 'pytest_asyncio' ``` - exclude docs PR ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? 1. test locally: ```bash # Install dependencies. pip install -r requirements-docs.txt # Build the docs and preview make clean; make html; python -m http.server -d build/html/ ``` Launch browser and open http://localhost:8000/. 2. CI passed with preview: https://vllm-ascend--55.org.readthedocs.build/en/55/ Signed-off-by: Yikun Jiang <yikunkero@gmail.com> 2025-02-13 18:44:17 +08:00			`## Build the docs`

			```bash
			`# Install dependencies.`
			`pip install -r requirements-docs.txt`

			`# Build the docs.`
			`make clean`
			`make html`

[Doc]Add Chinese translation for documentation (#1870) ### What this PR does / why we need it? This PR adds a complete Chinese translation for the documentation using PO files and the gettext toolchain. The goal is to make the documentation more accessible to Chinese-speaking users and help the community grow. ### Does this PR introduce any user-facing change? Yes. This PR introduces Chinese documentation, which users can access alongside the original English documentation. No changes to the core code or APIs. ### How was this patch tested? The translated documentation was built locally using the standard documentation build process (`make html` or `sphinx-build`). I checked the generated HTML pages to ensure the Chinese content displays correctly and matches the original structure. No code changes were made, so no additional code tests are required. vLLM version: v0.9.2 vLLM main: vllm-project/vllm@5780121 --- Please review the translation and let me know if any improvements are needed. I am happy to update the translation based on feedback. - vLLM version: v0.9.2 - vLLM main: https://github.com/vllm-project/vllm/commit/7ba34b1241ada58f8212f350a8b17382cb412cf2 --------- Signed-off-by: aidoczh <aidoczh@163.com> Signed-off-by: Yikun Jiang <yikunkero@gmail.com> Co-authored-by: Yikun Jiang <yikunkero@gmail.com> 2025-07-21 11:26:27 +08:00			`# Build the docs with translation`
			`make intl`
[Doc] Add sphinx build for vllm-ascend (#55) ### What this PR does / why we need it? This patch enables the doc build for vllm-ascend - Add sphinx build for vllm-ascend - Enable readthedocs for vllm-ascend - Fix CI: - exclude vllm-empty/tests/mistral_tool_use to skip `You need to agree to share your contact information to access this model` which introduce in https://github.com/vllm-project/vllm/commit/314cfade02b28d50349c4df1a7ea0bbdaef589f1 - Install test req to fix https://github.com/vllm-project/vllm-ascend/actions/runs/13304112758/job/37151690770: ``` vllm-empty/tests/mistral_tool_use/conftest.py:4: in <module> import pytest_asyncio E ModuleNotFoundError: No module named 'pytest_asyncio' ``` - exclude docs PR ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? 1. test locally: ```bash # Install dependencies. pip install -r requirements-docs.txt # Build the docs and preview make clean; make html; python -m http.server -d build/html/ ``` Launch browser and open http://localhost:8000/. 2. CI passed with preview: https://vllm-ascend--55.org.readthedocs.build/en/55/ Signed-off-by: Yikun Jiang <yikunkero@gmail.com> 2025-02-13 18:44:17 +08:00
[Doc]Add Chinese translation for documentation (#1870) ### What this PR does / why we need it? This PR adds a complete Chinese translation for the documentation using PO files and the gettext toolchain. The goal is to make the documentation more accessible to Chinese-speaking users and help the community grow. ### Does this PR introduce any user-facing change? Yes. This PR introduces Chinese documentation, which users can access alongside the original English documentation. No changes to the core code or APIs. ### How was this patch tested? The translated documentation was built locally using the standard documentation build process (`make html` or `sphinx-build`). I checked the generated HTML pages to ensure the Chinese content displays correctly and matches the original structure. No code changes were made, so no additional code tests are required. vLLM version: v0.9.2 vLLM main: vllm-project/vllm@5780121 --- Please review the translation and let me know if any improvements are needed. I am happy to update the translation based on feedback. - vLLM version: v0.9.2 - vLLM main: https://github.com/vllm-project/vllm/commit/7ba34b1241ada58f8212f350a8b17382cb412cf2 --------- Signed-off-by: aidoczh <aidoczh@163.com> Signed-off-by: Yikun Jiang <yikunkero@gmail.com> Co-authored-by: Yikun Jiang <yikunkero@gmail.com> 2025-07-21 11:26:27 +08:00			`# Open the docs with your browser`
Add an example for user stories (#399) Add an example for user stories and fix some typo Add a new section, user story in the docs, to collect user stories of llvm-ascend, also add an example and the issue template to collect user story Signed-off-by: Zhenyu Zheng <zheng.zhenyu@outlook.com> 2025-03-26 16:25:57 +08:00			`python -m http.server -d _build/html/`
[Doc] Add sphinx build for vllm-ascend (#55) ### What this PR does / why we need it? This patch enables the doc build for vllm-ascend - Add sphinx build for vllm-ascend - Enable readthedocs for vllm-ascend - Fix CI: - exclude vllm-empty/tests/mistral_tool_use to skip `You need to agree to share your contact information to access this model` which introduce in https://github.com/vllm-project/vllm/commit/314cfade02b28d50349c4df1a7ea0bbdaef589f1 - Install test req to fix https://github.com/vllm-project/vllm-ascend/actions/runs/13304112758/job/37151690770: ``` vllm-empty/tests/mistral_tool_use/conftest.py:4: in <module> import pytest_asyncio E ModuleNotFoundError: No module named 'pytest_asyncio' ``` - exclude docs PR ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? 1. test locally: ```bash # Install dependencies. pip install -r requirements-docs.txt # Build the docs and preview make clean; make html; python -m http.server -d build/html/ ``` Launch browser and open http://localhost:8000/. 2. CI passed with preview: https://vllm-ascend--55.org.readthedocs.build/en/55/ Signed-off-by: Yikun Jiang <yikunkero@gmail.com> 2025-02-13 18:44:17 +08:00			```

[Doc]Add Chinese translation for documentation (#1870) ### What this PR does / why we need it? This PR adds a complete Chinese translation for the documentation using PO files and the gettext toolchain. The goal is to make the documentation more accessible to Chinese-speaking users and help the community grow. ### Does this PR introduce any user-facing change? Yes. This PR introduces Chinese documentation, which users can access alongside the original English documentation. No changes to the core code or APIs. ### How was this patch tested? The translated documentation was built locally using the standard documentation build process (`make html` or `sphinx-build`). I checked the generated HTML pages to ensure the Chinese content displays correctly and matches the original structure. No code changes were made, so no additional code tests are required. vLLM version: v0.9.2 vLLM main: vllm-project/vllm@5780121 --- Please review the translation and let me know if any improvements are needed. I am happy to update the translation based on feedback. - vLLM version: v0.9.2 - vLLM main: https://github.com/vllm-project/vllm/commit/7ba34b1241ada58f8212f350a8b17382cb412cf2 --------- Signed-off-by: aidoczh <aidoczh@163.com> Signed-off-by: Yikun Jiang <yikunkero@gmail.com> Co-authored-by: Yikun Jiang <yikunkero@gmail.com> 2025-07-21 11:26:27 +08:00			`Launch your browser and open:`
[Lint]Style: reformat markdown files via markdownlint (#5884) ### What this PR does / why we need it? reformat markdown files via markdownlint - vLLM version: v0.13.0 - vLLM main: https://github.com/vllm-project/vllm/commit/bde38c11df0ea066a740efe9b77fff5418be45df --------- Signed-off-by: root <root@LAPTOP-VQKDDVMG.localdomain> Signed-off-by: MrZ20 <2609716663@qq.com> Co-authored-by: root <root@LAPTOP-VQKDDVMG.localdomain> 2026-01-15 09:06:01 +08:00
			`- English version: <http://localhost:8000>`
			`- Chinese version: <http://localhost:8000/zh_CN>`