Skip to content

Commit 1134778

Browse files
authored
[DOCS] Remove prebuilt package references and disable Colab button at tutorials (#18436)
1 parent 2523ee1 commit 1134778

File tree

2 files changed

+9
-17
lines changed

2 files changed

+9
-17
lines changed

docs/conf.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ def split_code_and_text_blocks(source_file, return_node, real_func):
121121

122122

123123
# This header replaces the default sphinx-gallery one in sphinx_gallery/gen_rst.py.
124+
# Colab button has been temporarily disabled due to prebuilt packages unavailability.
124125
COLAB_HTML_HEADER = """
125126
.. DO NOT EDIT. THIS FILE WAS AUTOMATICALLY GENERATED BY
126127
.. TVM'S MONKEY-PATCHED VERSION OF SPHINX-GALLERY. TO MAKE
@@ -132,13 +133,7 @@ def split_code_and_text_blocks(source_file, return_node, real_func):
132133
.. note::
133134
:class: sphx-glr-download-link-note
134135
135-
This tutorial can be used interactively with Google Colab! You can also click
136-
:ref:`here <sphx_glr_download_{ref_name}>` to run the Jupyter notebook locally.
137-
138-
.. image:: {button_svg}
139-
:align: center
140-
:target: {colab_url}
141-
:width: 300px
136+
You can click :ref:`here <sphx_glr_download_{ref_name}>` to run the Jupyter notebook locally.
142137
143138
.. rst-class:: sphx-glr-example-title
144139
@@ -162,7 +157,11 @@ def split_code_and_text_blocks(source_file, return_node, real_func):
162157
def save_rst_example(
163158
example_rst, example_file, time_elapsed, memory_used, gallery_conf, language, real_func
164159
):
165-
"""Monkey-patch save_rst_example to include the "Open in Colab" button."""
160+
"""Monkey-patch save_rst_example to customize the tutorial header.
161+
162+
Note: Colab button has been temporarily disabled. The colab_url and button_svg
163+
are still generated but not used in the header template.
164+
"""
166165

167166
# The url is the md5 hash of the notebook path.
168167
example_fname = os.path.relpath(example_file, gallery_conf["src_dir"])
@@ -171,6 +170,7 @@ def save_rst_example(
171170
digest = md5(notebook_path.encode()).hexdigest()
172171

173172
# Fixed documentation versions must link to different (earlier) .ipynb notebooks.
173+
# Note: colab_url is generated but not currently used in the header template.
174174
colab_url = f"{COLAB_URL_BASE}/{IPYTHON_GITHUB_BASE}"
175175
if "dev" not in version:
176176
colab_url += version + "/"

docs/install/index.rst

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,4 @@ If you are interested in deploying to mobile or embedded devices, you do not nee
3232
install the entire TVM stack on your device. Instead, you only need the runtime.
3333

3434
If you would like to quickly try out TVM or run some demo and tutorials, you
35-
can :ref:`install from Docker <docker-images>`. You can also use TVM locally through ``pip``.
36-
37-
.. code-block::
38-
39-
# Linux/MacOS CPU build only!
40-
# See tlcpack.ai for other pre-built binaries including CUDA
41-
pip install apache-tvm
42-
43-
For more details on installation of pre-built binaries, visit `tlcpack.ai <https://tlcpack.ai>`_.
35+
can :ref:`install from Docker <docker-images>`.

0 commit comments

Comments
 (0)