Skip to content

Fix building doc#1347

Merged
csukuangfj merged 1 commit intomasterfrom
fix-doc
Mar 6, 2026
Merged

Fix building doc#1347
csukuangfj merged 1 commit intomasterfrom
fix-doc

Conversation

@csukuangfj
Copy link
Copy Markdown
Collaborator

No description provided.

@csukuangfj csukuangfj merged commit ccc52dc into master Mar 6, 2026
1 check passed
@gemini-code-assist
Copy link
Copy Markdown

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 issues encountered during the documentation build process by modifying the docs/requirements.txt file. It removes strict version constraints on several dependencies, allowing for more flexible package resolution and preventing conflicts that might hinder the build.

Highlights

  • Documentation Dependencies: Removed specific version pins for several packages in docs/requirements.txt to resolve potential conflicts and facilitate successful documentation builds.
Changelog
  • docs/requirements.txt
    • Removed specific version pins for documentation dependencies.
Ignored Files
  • Ignored by pattern: .github/workflows/** (2)
    • .github/workflows/build-doc.yml
    • .github/workflows/ubuntu-arm64-cpu-wheels.yml
Activity
  • No specific activity (comments, reviews, progress updates) has been recorded for this pull request yet.
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.

@csukuangfj csukuangfj deleted the fix-doc branch March 6, 2026 08:47
Copy link
Copy Markdown

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

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 removes version pinning for documentation dependencies and also removes torch from the list. While this may resolve an immediate build issue, it introduces a risk of future build failures due to unpinned dependencies. For long-term maintainability and build reproducibility, it is crucial to pin dependency versions. I've added a comment with a recommendation to pin the versions to a known-good configuration and to re-add torch if it is a necessary dependency for the documentation build.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment thread docs/requirements.txt
Comment on lines +1 to +8
dataclasses
graphviz
recommonmark
sphinx
sphinx-autodoc-typehints
sphinx_rtd_theme
sphinxcontrib-bibtex
sphinxcontrib-youtube
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

high

While unpinning dependencies might fix the current build issue, it can lead to non-reproducible builds in the future. A new release of any of these packages could introduce breaking changes and cause the documentation build to fail.

It is strongly recommended to pin dependencies to specific versions to ensure build stability. Please find a compatible set of versions that resolves the build issue and pin them in this file.

For example:

sphinx==5.3.0
# etc.

Additionally, torch has been removed from the requirements. However, it appears to be used in docs/source/conf.py. If torch is a dependency for building the documentation, it should be included in this file to ensure the build environment is correctly set up and self-contained.

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