-
Notifications
You must be signed in to change notification settings - Fork 48
doc: Add version switcher #343
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @junrushao, 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 significantly enhances the tvm-ffi documentation by introducing a robust version switching mechanism. By leveraging sphinx-multiversion and custom scripting, the documentation site can now host and display multiple versions of the documentation, including the main branch and specific release tags. This change improves the user experience by making it easier to access and compare documentation across different project versions. Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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 introduces a version switcher for the documentation site, which is a valuable addition for users. The implementation leverages sphinx-multiversion and includes a new build script and a Python helper to generate the version metadata. The overall approach is solid. I've identified a few areas for improvement in the new Python script, primarily concerning more specific exception handling and correcting a type hint, to enhance code robustness and maintainability.
e544e39 to
4920279
Compare
|
/gemini review |
There was a problem hiding this 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 introduces a version switcher for the documentation site, enabling users to navigate between different versions of the documentation (specifically main and version tags). The implementation leverages sphinx-multiversion and includes a new build script and a Python helper to generate the necessary version metadata. The changes are well-implemented and significantly improve the documentation's usability. I've added a few suggestions to enhance the robustness of the build process and the new scripts by using more specific exception handling and improving the documentation for the build command.
4920279 to
c704041
Compare
c704041 to
f217b4e
Compare
f217b4e to
6ff5450
Compare

This PR adds a version switcher on tvm-ffi doc site, so that one could look up docs based on different version tags.
The multi-version site can be built with the simple instruction below:
Demo in thread: #343 (comment)