diff --git a/docs/README.md b/docs/README.md index 9e7c4a6c..afdd0fde 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,7 @@ # vLLM Ascend Plugin documents +Live doc: https://vllm-ascend.readthedocs.io + ## Build the docs ```bash diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index e837e992..2d18af23 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,8 +1,9 @@ -sphinx==6.2.1 -sphinx-argparse==0.4.0 -sphinx-book-theme==1.0.1 -sphinx-copybutton==0.5.2 -sphinx-design==0.6.1 -sphinx-togglebutton==0.3.2 -myst-parser==3.0.1 +sphinx +sphinx-argparse +sphinx-book-theme +sphinx-copybutton +sphinx-design +sphinx-togglebutton +myst-parser msgspec +sphinx-substitution-extensions diff --git a/docs/source/conf.py b/docs/source/conf.py index 89352308..f51af25f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -53,10 +53,20 @@ "sphinxarg.ext", "sphinx_design", "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. templates_path = ['_templates'] diff --git a/docs/source/installation.md b/docs/source/installation.md index 21fde1dc..bc047875 100644 --- a/docs/source/installation.md +++ b/docs/source/installation.md @@ -117,12 +117,14 @@ pip install vllm vllm-ascend -f https://download.pytorch.org/whl/torch/ or build from **source code**: -```bash -git clone https://github.com/vllm-project/vllm +```{code-block} bash + :substitutions: + +git clone --depth 1 --branch |vllm_version| https://github.com/vllm-project/vllm cd vllm 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 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]) DEVICE=/dev/davinci7 # 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 run --rm \ --name vllm-ascend-env \ diff --git a/docs/source/quick_start.md b/docs/source/quick_start.md index 1c3d907b..028e293c 100644 --- a/docs/source/quick_start.md +++ b/docs/source/quick_start.md @@ -69,15 +69,17 @@ pip install --upgrade pip You can install vLLM and vllm-ascend plugin by using: -```bash -# Install vLLM main branch (About 5 mins) -git clone --depth 1 https://github.com/vllm-project/vllm.git +```{code-block} bash + :substitutions: + +# Install vLLM (About 5 mins) +git clone --depth 1 --branch |vllm_version| https://github.com/vllm-project/vllm.git cd vllm VLLM_TARGET_DEVICE=empty pip install . cd .. # 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 pip install -e . cd ..