Skip to content

[Docker] Switch docs image theme deps to sphinx-book-theme#19835

Open
tlopex wants to merge 1 commit into
apache:mainfrom
tlopex:docker-deps-book-theme
Open

[Docker] Switch docs image theme deps to sphinx-book-theme#19835
tlopex wants to merge 1 commit into
apache:mainfrom
tlopex:docker-deps-book-theme

Conversation

@tlopex

@tlopex tlopex commented Jun 18, 2026

Copy link
Copy Markdown
Member

For the docs/conf.py migration to sphinx-book-theme, update the ci-gpu docs dependencies:

  • ubuntu_install_sphinx.sh: replace sphinx_rtd_theme + tlcpack-sphinx-addon with sphinx-book-theme==1.1.4 + pydata-sphinx-theme==0.15.4.
  • ubuntu_install_python_package.sh: drop the now-unused tlcpack-sphinx-addon pin.

sphinx-book-theme 1.1.4 (not 1.2.0) supports both Sphinx 8.1.3 (sphinx>=6.1, no upper bound) and the docs 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.

For the docs/conf.py migration to sphinx-book-theme, update the ci-gpu docs
dependencies:
- ubuntu_install_sphinx.sh: replace sphinx_rtd_theme + tlcpack-sphinx-addon with
  sphinx-book-theme==1.1.4 + pydata-sphinx-theme==0.15.4.
- ubuntu_install_python_package.sh: drop the now-unused tlcpack-sphinx-addon pin.

sphinx-book-theme 1.1.4 (not 1.2.0) supports both Sphinx 8.1.3 (sphinx>=6.1, no
upper bound) and the docs 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.

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; the docs/conf.py theme
switch should land together so the rtd-based build is never left without a theme.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the Sphinx documentation setup in the Docker installation scripts. Specifically, it removes the tlcpack-sphinx-addon package from both the general Python package installation and the Sphinx installation scripts. Additionally, it replaces the sphinx_rtd_theme with sphinx-book-theme and pydata-sphinx-theme in the Sphinx installation script. There are no review comments, and I have no feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant