Support multi-version docs

[pan-x-c]

Description

As the title says

Checklist

Please check the following items before code is ready to be reviewed.

• Code has passed all tests
• Docstrings have been added/updated in Google Style
• Documentation has been updated
• Code is ready for review

[gemini-code-assist]

Summary of Changes

Hello @pan-x-c, I'm Gemini Code Assist¹! 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 introduces comprehensive support for multi-version documentation using Sphinx, enabling the generation and display of documentation for different branches and tags. This significantly improves the maintainability and accessibility of project documentation by allowing users to easily switch between various versions of the docs.

Highlights

• Multi-version Documentation Setup: Integrated sphinx-multiversion and sphinxcontrib-apidoc to enable the generation of documentation for multiple versions (branches and tags) of the project.
• Automated Documentation Builds: The build_doc.sh script has been refactored to leverage sphinx-multiversion and now includes a --current-branch option, allowing developers to build documentation specifically for their active development branch.
• Enhanced Documentation Navigation: New templates (package.rst_t, versions.html) and configuration in conf.py provide a user-friendly interface for navigating between different documentation versions directly within the generated HTML output.
• Dependency Updates: Added necessary Sphinx-related packages (sphinxcontrib-apidoc, sphinx-multiversion) to pyproject.toml to support the new documentation features.
• Version Bump: The project version in trinity/init.py has been updated from a development version to a stable release.

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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]

Code Review

This pull request introduces support for multi-version documentation using sphinx-multiversion. The changes are comprehensive, covering Sphinx configuration, new templates for versioning, updates to the build script, and adjustments to project dependencies and documentation. My review focuses on enhancing the robustness of the new build script to prevent potential issues with file state during the build process.