correct format doc errors

Signed-off-by: Maxime Fournioux <[email protected]>
vllm-project · Dec 4, 2024 · 3549861 · 3549861
1 parent fd1f830
commit 3549861
Showing 1 changed file with 15 additions and 18 deletions.
diff --git a/docs/source/serving/deploying_with_helm.rst b/docs/source/serving/deploying_with_helm.rst
@@ -3,8 +3,6 @@
 Deploying with Helm
 ===================
 
-|Version: 0.0.1| |Type: application|
-
 A Helm chart to deploy vLLM for Kubernetes
 
 Application development in Kubernetes can be inherently complex. For any given application, you might be managing hundreds of configurations. As a package manager for Kubernetes, using Helm to deploy vLLM on k8s will help you to automate the deployment of vLLMm Kubernetes applications by combining configuration files into a single reusable package. Helm enables you to apply the same configuration framework to multiple instances using variable overrides.
@@ -20,30 +18,34 @@ Before you begin, ensure that you have the following:
 - Available GPU resources in your cluster
 - S3 with the model which will be deployed
 
-## Installing the chart
+Installing the chart
+--------------------
 
 To install the chart with the release name `test-vllm`
 
-``` console
-helm upgrade --install --create-namespace --namespace=ns-vllm test-vllm . -f values.yaml --set secrets.s3endpoint=$ACCESS_POINT --set secrets.s3buckername=$BUCKET --set secrets.s3accesskeyid=$ACCESS_KEY --set secrets.s3accesskey=$SECRET_KEY
-```
+.. code-block:: console
+
+    helm upgrade --install --create-namespace --namespace=ns-vllm test-vllm . -f values.yaml --set secrets.s3endpoint=$ACCESS_POINT --set secrets.s3buckername=$BUCKET --set secrets.s3accesskeyid=$ACCESS_KEY --set secrets.s3accesskey=$SECRET_KEY
 
-## ➖ Uninstalling the Chart
+Uninstalling the Chart
+----------------------
 
 To uninstall the `test-vllm` deployment
 
-``` console
-helm uninstall test-vllm --namespace=ns-vllm
-```
+.. code-block:: console
+
+    helm uninstall test-vllm --namespace=ns-vllm
 
 The command removes all the Kubernetes components associated with the
 chart **including persistent volumes** and deletes the release.
 
-## Architecture
+Architecture
+------------
 
 ![Architecture](architecture_helm_deployment.excalidraw.png)
 
-## Values
+Values
+------
 
   --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
   Key                                          Type         Default                                                                                                                                                      Description
@@ -188,9 +190,4 @@ chart **including persistent volumes** and deletes the release.
   labels.environment                           string       `test`                                                                                                                                                       Environment name
 
   labels.release                               string       `test`                                                                                                                                                       Release name
-  --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
-------------------------------------------------------------------------
-
-Autogenerated from chart metadata using [helm-docs
-v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
+  --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------