Update Docs Theme

[hiyuchang]

Description

1. update the doc theme to awesome
2. update the multi-turn tutorial

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 @hiyuchang, 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 primarily focuses on enhancing the user experience of the project's documentation. It involves a significant update to the Sphinx documentation theme, switching to sphinxawesome_theme for a potentially improved visual and navigational experience. Concurrently, the pull request refactors the API reference documentation into a single, consolidated page and provides more comprehensive setup instructions for the multi-turn tutorial.

Highlights

• Documentation Theme Update: The Sphinx documentation theme has been switched from sphinx_rtd_theme to sphinxawesome_theme to modernize the look and feel of the documentation.
• Consolidated API Reference: A new api_reference.rst file has been introduced to centralize the API documentation for various trinity modules, replacing individual module links in the index.rst.
• Enhanced Multi-Turn Tutorial: The example_multi_turn.md tutorial now includes detailed, collapsible setup guidelines for the ALFWorld and WebShop environments, making it easier for users to get started.
• Documentation Path Adjustments: Numerous relative links within the main.md and example_data_functionalities.md files have been updated to reflect the new documentation structure and ensure correct navigation with the updated theme.

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 or fill out our survey to provide feedback.

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 updates the documentation theme to sphinxawesome_theme and refactors the API reference generation. The changes also include updates to various documentation pages, such as improving link consistency and adding detailed setup instructions for multi-turn examples.

I've found a few issues:

• The new API reference page attempts to document modules that will either produce misleading (trinity.manager) or empty (trinity.common, trinity.utils) content due to issues in their respective __init__.py files.
• The new setup instructions for the WebShop environment in the multi-turn tutorial contain a redundant step and an ambiguously phrased command.

My detailed feedback is in the comments below. Overall, these are great improvements to the documentation structure and content.

[gemini-code-assist]

The trinity.common module has an empty __init__.py file, so automodule will generate an empty documentation section. If this module is intended to be part of the public API, please export its members. Otherwise, it should be removed from this API reference file.

[gemini-code-assist]

The trinity.utils module has an empty __init__.py file, so automodule will generate an empty documentation section. If this module is intended to be part of the public API, please export its members. Otherwise, it should be removed from this API reference file.

[gemini-code-assist]

The links in this section have been updated to remove the redundant docs/sphinx_doc/source/ path. Ensure that all other internal links in the documentation have been updated accordingly to maintain consistency.