Skip to content

[CI][Docs] Update Sphinx dependencies#18860

Merged
tqchen merged 1 commit into
apache:mainfrom
mshr-h:update-sphinx-deps
Mar 1, 2026
Merged

[CI][Docs] Update Sphinx dependencies#18860
tqchen merged 1 commit into
apache:mainfrom
mshr-h:update-sphinx-deps

Conversation

@mshr-h

@mshr-h mshr-h commented Mar 1, 2026

Copy link
Copy Markdown
Contributor

Fix CI errors on docs generation. Part of #18827

Verifies that docs are generated correctly on local:

  • docker/build.sh ci_gpu && python tests/scripts/ci.py docs -d tvm.ci_gpu then
  • python tests/scripts/ci.py serve-docs

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses continuous integration failures related to documentation generation by upgrading key Sphinx-related Python dependencies. The updates ensure compatibility and resolve issues preventing the successful build of documentation, thereby restoring the integrity of the CI pipeline for documentation tasks.

Highlights

  • Dependency Updates: Updated several Sphinx-related Python dependencies to newer versions, including autodocsumm, docutils, matplotlib, sphinx, and sphinx_rtd_theme.
  • Sphinx-Gallery Specification: Changed the sphinx-gallery dependency from a direct Git URL reference to a specific version 0.20.0.
  • TLCpack Sphinx Addon: Updated the Git commit hash for the tlcpack-sphinx-addon dependency.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docker/install/ubuntu_install_sphinx.sh
    • Updated autodocsumm from 0.2.7 to 0.2.14
    • Updated docutils from 0.16 to 0.21.2
    • Updated matplotlib from 3.3.4 to 3.10.8
    • Updated sphinx from 4.2.0 to 8.1.3
    • Updated sphinx_rtd_theme from 1.0.0 to 3.1.0
    • Changed sphinx-gallery from a Git URL to version 0.20.0
    • Updated the Git hash for tlcpack-sphinx-addon
Activity
  • Identified and addressed CI errors occurring during documentation generation.
  • Linked to issue [CI] Update images to 20260301-134651-63f099ad #18827, indicating this PR is part of a larger fix.
  • Verified successful documentation generation locally using docker/build.sh ci_gpu and python tests/scripts/ci.py docs commands.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@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 several Sphinx-related Python dependencies in the ubuntu_install_sphinx.sh script to fix CI errors during documentation generation. The changes involve updating package versions to more recent ones and replacing a git-based dependency for sphinx-gallery with a pinned version from PyPI. My review includes a suggestion to improve maintainability by moving the list of dependencies into a separate requirements.txt file.

Comment thread docker/install/ubuntu_install_sphinx.sh
@mshr-h mshr-h marked this pull request as ready for review March 1, 2026 12:43
@mshr-h mshr-h changed the title [CI][Docs] Update Sphinx dependencies in ubuntu_install_sphinx.sh [CI][Docs] Update Sphinx dependencies Mar 1, 2026
@mshr-h mshr-h marked this pull request as draft March 1, 2026 12:47
@mshr-h mshr-h marked this pull request as ready for review March 1, 2026 13:06
@mshr-h

mshr-h commented Mar 1, 2026

Copy link
Copy Markdown
Contributor Author

ready to go
cc @tqchen @yongwww

@tqchen tqchen merged commit 63f099a into apache:main Mar 1, 2026
13 checks passed
@mshr-h mshr-h deleted the update-sphinx-deps branch March 1, 2026 13:28
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.

2 participants