Fix rendering after replacing . with + in wheel files

Signed-off-by: Hitarth Mehta <[email protected]>
quic · Dec 29, 2024 · 1f0051b · 1f0051b
1 parent a9a8e06
commit 1f0051b
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 13 deletions.
diff --git a/Docs/conf.py b/Docs/conf.py
@@ -194,7 +194,7 @@ def setup(app):
 # Parameters for use in templates
 
 html_context = {
-  'current_version' : "2.0",
+  'current_version' : version,
   'versions_page' : '<a href="https://quic.github.io/aimet-pages/releases/latest/versions.html">Other versions</a>'
 }
 

diff --git a/Docs/install/index.rst b/Docs/install/index.rst
@@ -45,13 +45,13 @@ Use one of the following commands to install AIMET based on your choice of frame
 
         .. parsed-literal::
 
-           python3 -m pip install |download_url|\ |version|/aimet_torch-\ |version|.cu121\ |whl_suffix| -f |torch_pkg_url|
+           python3 -m pip install |download_url|\ |version|/aimet_torch-|version|\+cu121\ |whl_suffix| -f |torch_pkg_url|
 
         With CPU only:
 
         .. parsed-literal::
 
-            python3 -m pip install |download_url|\ |version|/aimet_torch-\ |version|.cpu\ |whl_suffix| -f |torch_pkg_url|
+            python3 -m pip install |download_url|\ |version|/aimet_torch-|version|\+cpu\ |whl_suffix| -f |torch_pkg_url|
 
 
     .. tab-item:: TensorFlow
@@ -63,13 +63,13 @@ Use one of the following commands to install AIMET based on your choice of frame
 
         .. parsed-literal::
 
-            python3 -m pip install |download_url|\ |version|/aimet_tensorflow-\ |version|.cu118\ |whl_suffix| -f |torch_pkg_url|
+            python3 -m pip install |download_url|\ |version|/aimet_tensorflow-|version|\+cu118\ |whl_suffix|
 
         With CPU only:
 
         .. parsed-literal::
 
-            python3 -m pip install |download_url|\ |version|/aimet_tensorflow-\ |version|.cpu\ |whl_suffix| -f |torch_pkg_url|
+            python3 -m pip install |download_url|\ |version|/aimet_tensorflow-|version|\+cpu\ |whl_suffix|
 
     .. tab-item:: ONNX
         :sync: onnx
@@ -80,15 +80,15 @@ Use one of the following commands to install AIMET based on your choice of frame
 
         .. parsed-literal::
 
-            python3 -m pip install |download_url|\ |version|/aimet_onnx-\ |version|.cu118\ |whl_suffix| -f |torch_pkg_url|
+            python3 -m pip install |download_url|\ |version|/aimet_onnx-|version|\+cu118\ |whl_suffix| -f |torch_pkg_url|
 
         With CPU only:
 
         .. parsed-literal::
 
-            python3 -m pip install |download_url|\ |version|/aimet_onnx-\ |version|.cpu\ |whl_suffix| -f |torch_pkg_url|
+            python3 -m pip install |download_url|\ |version|/aimet_onnx-|version|\+cpu\ |whl_suffix| -f |torch_pkg_url|
 
-.. |whl_suffix| replace:: -cp310-cp310-manylinux_2_34_x86_64.whl
+.. |whl_suffix| replace:: \-cp310-cp310-manylinux_2_34_x86_64.whl
 .. |download_url| replace:: \https://github.com/quic/aimet/releases/download/
 .. |torch_pkg_url| replace:: \https://download.pytorch.org/whl/torch_stable.html
 

diff --git a/Docs/install/install_docker.rst b/Docs/install/install_docker.rst
@@ -238,7 +238,7 @@ Releases are listed at: https://github.com/quic/aimet/releases
     export download_url="\https://github.com/quic/aimet/releases/download/${release_tag}"
 
     # Set the wheel file name with extension,
-    # for example "aimet_tensorflow-|version|+cu118-cp310-cp310-manylinux_2_34_x86_64.whl"
+    # for example "aimet_torch-|version|\+cu121-cp310-cp310-manylinux_2_34_x86_64.whl"
     export wheel_file_name="<wheel file name>"
 
     # NOTE: Do the following only for the PyTorch and ONNX variant packages!

diff --git a/Docs/install/install_host.rst b/Docs/install/install_host.rst
@@ -116,7 +116,7 @@ For example, "|version|". Releases are listed at: https://github.com/quic/aimet/
     export download_url="\https://github.com/quic/aimet/releases/download/${release_tag}"
 
     # Set the wheel file name with extension,
-    # for example "aimet_torch-|version|+cu121-cp310-cp310-manylinux_2_34_x86_64.whl"
+    # for example "aimet_torch-|version|\+cu121-cp310-cp310-manylinux_2_34_x86_64.whl"
     export wheel_file_name="<wheel file name>"
 
     # NOTE: Do the following ONLY for the PyTorch and ONNX variant packages!
@@ -202,7 +202,7 @@ For example, "|version|". Releases are listed at: https://github.com/quic/aimet/
     export download_url="\https://github.com/quic/aimet/releases/download/${release_tag}"
 
     # Set the wheel file name with extension,
-    # for example "aimet_tensorflow-|version|+cu118-cp310-cp310-manylinux_2_34_x86_64.whl"
+    # for example "aimet_tensorflow-|version|\+cu118-cp310-cp310-manylinux_2_34_x86_64.whl"
     export wheel_file_name="<wheel file name>"
 
 **2.3 Install the selected AIMET package.**
@@ -278,9 +278,12 @@ For example, "|version|". Releases are listed at: https://github.com/quic/aimet/
     export download_url="\https://github.com/quic/aimet/releases/download/${release_tag}"
 
     # Set the wheel file name with extension,
-    # for example "aimet_onnx-|version|+cu118-cp310-cp310-manylinux_2_34_x86_64.whl"
+    # for example "aimet_onnx-|version|\+cu118-cp310-cp310-manylinux_2_34_x86_64.whl"
     export wheel_file_name="<wheel file name>"
 
+    # NOTE: Do the following ONLY for the PyTorch and ONNX variant packages!
+    export find_pkg_url_str="-f https://download.pytorch.org/whl/torch_stable.html"
+
 **3.3 Install the selected AIMET package.**
 
 .. note::
@@ -290,7 +293,7 @@ For example, "|version|". Releases are listed at: https://github.com/quic/aimet/
 .. code-block:: bash
 
     # Install the wheel package
-    python3 -m pip install ${download_url}/${wheel_file_name}
+    python3 -m pip install ${download_url}/${wheel_file_name} ${find_pkg_url_str}|
 
 **3.4 Install the common Debian packages.**