[Docs][CI] Switch docs theme and bump images to 20260619-214849-4174cdf5#19828
Merged
Conversation
Contributor
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
tlopex
force-pushed
the
docs-sphinx-book-theme
branch
from
c5d97dc to
5ed38bc
Compare
Member
Author
|
@tvm-bot rerun |
tlopex
force-pushed
the
docs-sphinx-book-theme
branch
from
5ed38bc to
3dcf69b
Compare
tlopex
added a commit
to tlopex/tvm
that referenced
this pull request
Jun 19, 2026
Bump the CI image Python dependencies, batched into one docker rebuild: Docs theme (for the sphinx-book-theme migration): - ubuntu_install_sphinx.sh: replace sphinx_rtd_theme + tlcpack-sphinx-addon with sphinx-book-theme==1.1.4 + pydata-sphinx-theme==0.15.4. 1.1.4 (not 1.2.0) is used because it supports both Sphinx 8.1.3 (sphinx>=6.1, no upper bound) and the image's Python 3.10 (requires-python>=3.9); 1.2.0 requires Python>=3.11. 1.1.4 hard-pins pydata-sphinx-theme==0.15.4. - ubuntu_install_python_package.sh: drop the now-unused tlcpack-sphinx-addon pin. Z3 prover: - ubuntu_install_python_package.sh: add z3-static==4.16.0.post1 for the optional Z3-backed Analyzer proving. This is the docker-bump step: after it merges and the rebuilt image is published, ci/jenkins/docker-images.ini is pointed at the new tag, after which the docs/conf.py book-theme switch (PR apache#19828) can build the docs.
Member
Author
|
@tvm-bot rerun |
tlopex
force-pushed
the
docs-sphinx-book-theme
branch
from
3dcf69b to
359cf82
Compare
Migrate the documentation site from sphinx_rtd_theme to sphinx-book-theme
(pydata-sphinx-theme based), matching the in-repo 3rdparty/tvm-ffi docs which
already use this theme.
The published theme was not plain sphinx_rtd_theme: it was tlcpack-sphinx-addon's
full standalone layout.html, injected via templates_path, which overrides any
html_theme. Switching the theme therefore also removes the addon's
template/static injection (otherwise the switch is a visual no-op).
docs/conf.py:
- html_theme = "sphinx_book_theme"; drop the dead TVM_THEME/READTHEDOCS
indirection that always resolved to sphinx_rtd_theme.
- Replace the RTD-only html_theme_options ({"logo_only": True}) with book-theme
options: repository_url/branch + path_to_docs driving the repository/edit/
source/issue buttons, GitHub + TVM-home icon_links, and an extra_footer with
the Community/Download/Docs links, ASF dropdown, and Apache trademark notice
(the copyright line is rendered natively by the theme, not duplicated).
- Remove the tlcpack_sphinx_addon import and its templates_path/html_static_path
injection, plus the now-unused html_context header/footer machinery and
fixup_tutorials.
- sphinx_gallery_conf["show_signature"] = False to drop the "Gallery generated
by Sphinx-Gallery" line.
- Remove the dead docs/_static/css/tvm_theme.css (RTD-only selectors, never linked).
tests/scripts/ci.py and docs/README.md: point the local docs requirements /
native-build instructions at sphinx-book-theme.
The CI image tag update is folded into this PR so the docs build runs on an
image with sphinx-book-theme and without tlcpack-sphinx-addon.
tlopex
force-pushed
the
docs-sphinx-book-theme
branch
from
359cf82 to
edc23dd
Compare
tlopex
changed the title
tlopex
changed the title
tqchen
approved these changes
Jun 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pr migrates the documentation site from sphinx_rtd_theme to sphinx-book-theme (pydata-sphinx-theme based).
docs/conf.py:
CI enablement folded into this PR:
tests/scripts/ci.py and docs/README.md are reconciled to the ci-gpu docs stack: Sphinx 8.1.3, sphinx-book-theme==1.1.4, pydata-sphinx-theme==0.15.4, and matching docs packages.
Preserved in the footer: ASF dropdown, Community/Download/Docs links, copyright, and Apache trademark notice. Intentionally dropped (no book-theme equivalent): the branded top nav bar, the version_prefixes dropdown (which did not render on the deployed site), and the tlcpack search-summary snippet. sphinx-gallery's own sg_gallery.css is unaffected, so tutorial thumbnail grids still render.