[Docs] Switch documentation theme to sphinx-book-theme#19828
Open
tlopex wants to merge 1 commit into
Open
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 |
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-gpu Docker image dependency change (add sphinx-book-theme, drop
sphinx_rtd_theme + tlcpack-sphinx-addon) is handled in a companion PR so the CI
image is rebuilt with the new theme before this switch lands.
tlopex
force-pushed
the
docs-sphinx-book-theme
branch
from
5ed38bc to
3dcf69b
Compare
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
1 participant
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:
Dependency pins updated in lockstep (sphinx-book-theme==1.2.0 is the minimum release compatible with Sphinx 8.1.3; it pins pydata-sphinx-theme==0.16.1):
sphinx-book-theme + pydata-sphinx-theme.
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.