tvm icon indicating copy to clipboard operation
tvm copied to clipboard

[Bug] Installation tutorial page shows unexpected blank code block.

Open ganler opened this issue 2 years ago • 2 comments

The installation page shows unexpected blank code block.

image

cc: @driazati

ganler avatar Aug 09 '22 00:08 ganler

I think this is coming from the sphinx_gallery_*_ignore tags, @guberti any idea why they'd show up as a blank code block when there's no other code in that block? This is probably fixable with a patch to sphinx-gallery or we could do the hacky thing and clean these up in JavaScript from tlcpack-sphinx-addon

driazati avatar Aug 09 '22 00:08 driazati

This is expected behavior from sphinx-gallery. The code that generates the empty block is:

# sphinx_gallery_start_ignore
from tvm import testing

testing.utils.install_request_hook(depth=3)
# sphinx_gallery_end_ignore

sphinx-gallery correctly removes everything between the *_ignore tags (leaving an empty code block) and then renders the empty code block as intended.

The easiest solution is to just remove that code. It was added by @driazati's https://github.com/apache/tvm/pull/11839 and is used to redirect URLS to S3 - since we don't have any other code in this tutorial, I think we can remove it without issue (though @driazati should confirm).

guberti avatar Aug 09 '22 06:08 guberti