EngineX/xc-llm-ascend
3
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Wiki Activity

[Docs] Add dynamic version in docs (#90)

Browse Source 
### 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>
This commit is contained in:
Yikun Jiang
2025-02-19 08:57:27 +08:00
committed by GitHub
parent c18fb09b55
commit 17de078d83
5 changed files with 35 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@@ -1,5 +1,7 @@
# vLLM Ascend Plugin documents # vLLM Ascend Plugin documents
Live doc: https://vllm-ascend.readthedocs.io
## Build the docs ## Build the docs
```bash ```bash

15
docs/requirements-docs.txt
View File

@@ -1,8 +1,9 @@
sphinx==6.2.1 sphinx
sphinx-argparse==0.4.0 sphinx-argparse
sphinx-book-theme==1.0.1 sphinx-book-theme
sphinx-copybutton==0.5.2 sphinx-copybutton
sphinx-design==0.6.1 sphinx-design
sphinx-togglebutton==0.3.2 sphinx-togglebutton
myst-parser==3.0.1 myst-parser
msgspec msgspec
sphinx-substitution-extensions

16
docs/source/conf.py
View File

@@ -53,10 +53,20 @@ extensions = [
"sphinxarg.ext", "sphinxarg.ext",
"sphinx_design", "sphinx_design",
"sphinx_togglebutton", "sphinx_togglebutton",
"sphinx_substitution_extensions",
] ]
myst_enable_extensions = [
"colon_fence", myst_enable_extensions = ["colon_fence", "substitution"]
]
# Change this when cut down release
myst_substitutions = {
# the branch of vllm, used in vllm clone
# such as 'main', 'v0.7.1'
'vllm_version': 'main',
# the branch of vllm-ascend, used in vllm-ascend clone and image tag
# such as 'main', 'v0.7.1-dev', 'v0.7.1rc1'
'vllm_ascend_version': 'main'
}
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']

10
docs/source/installation.md
View File

@@ -117,12 +117,14 @@ pip install vllm vllm-ascend -f https://download.pytorch.org/whl/torch/
or build from **source code**: or build from **source code**:
```bash ```{code-block} bash
git clone https://github.com/vllm-project/vllm :substitutions:
git clone --depth 1 --branch |vllm_version| https://github.com/vllm-project/vllm
cd vllm cd vllm
VLLM_TARGET_DEVICE=empty pip install . -f https://download.pytorch.org/whl/torch/ VLLM_TARGET_DEVICE=empty pip install . -f https://download.pytorch.org/whl/torch/
git clone https://github.com/vllm-project/vllm-ascend.git git clone --depth 1 --branch |vllm_ascend_version| https://github.com/vllm-project/vllm-ascend.git
cd vllm-ascend cd vllm-ascend
pip install -e . -f https://download.pytorch.org/whl/torch/ pip install -e . -f https://download.pytorch.org/whl/torch/
``` ```
@@ -138,7 +140,7 @@ You can just pull the **prebuilt image** and run it with bash.
# Update DEVICE according to your device (/dev/davinci[0-7]) # Update DEVICE according to your device (/dev/davinci[0-7])
DEVICE=/dev/davinci7 DEVICE=/dev/davinci7
# Update the vllm-ascend image # Update the vllm-ascend image
IMAGE=quay.io/ascend/vllm-ascend:main IMAGE=quay.io/ascend/vllm-ascend:|vllm_ascend_version|
docker pull $IMAGE docker pull $IMAGE
docker run --rm \ docker run --rm \
--name vllm-ascend-env \ --name vllm-ascend-env \

10
docs/source/quick_start.md
View File

@@ -69,15 +69,17 @@ pip install --upgrade pip
You can install vLLM and vllm-ascend plugin by using: You can install vLLM and vllm-ascend plugin by using:
```bash ```{code-block} bash
# Install vLLM main branch (About 5 mins) :substitutions:
git clone --depth 1 https://github.com/vllm-project/vllm.git
# Install vLLM (About 5 mins)
git clone --depth 1 --branch |vllm_version| https://github.com/vllm-project/vllm.git
cd vllm cd vllm
VLLM_TARGET_DEVICE=empty pip install . VLLM_TARGET_DEVICE=empty pip install .
cd .. cd ..
# Install vLLM Ascend Plugin: # Install vLLM Ascend Plugin:
git clone --depth 1 https://github.com/vllm-project/vllm-ascend.git git clone --depth 1 --branch |vllm_ascend_version| https://github.com/vllm-project/vllm-ascend.git
cd vllm-ascend cd vllm-ascend
pip install -e . pip install -e .
cd .. cd ..