Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @asmacdo, 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 focuses on updating and streamlining the project's documentation build process on ReadTheDocs. It migrates to a newer configuration version, specifies a modern Python environment, and cleans up an outdated dependency, ensuring the documentation builds reliably and securely.
Highlights
- ReadTheDocs Configuration Update: The ReadTheDocs build configuration has been significantly updated to
version: 2, specifyingubuntu-22.04as the build OS andpython: 3.12as the build tool. This modernizes the documentation build environment. - Dependency Management for Docs: The Python installation process for ReadTheDocs builds has been refined to explicitly use
requirements.txtandrequirements-devel.txt, ensuring all necessary dependencies are installed for documentation generation. - Deprecated Dependency Removal: The
pycryptodependency, which is no longer maintained and has known security concerns, has been removed from the project'ssetup.py.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the Read the Docs configuration to the modern version: 2 format, which is a great improvement. It correctly updates the Python version to 3.12, aligning with the project's requirements, and removes the outdated pycrypto dependency. My main feedback is a suggestion to simplify the package installation steps in readthedocs.yml to make the build process more efficient and the configuration easier to maintain.
|
Checked again with the gemini suggestion and docs build as expected |
b266539 to
7831c6d
Compare
d007f07 to
e656b69
Compare
|
in https://app.readthedocs.org/dashboard/reproman/edit/ . Let's push smth useful and see if builds ok? |
|
build passes, so let's go |

rtd now uses v2 configuration, this PR updates to the new requirements.
To test I had rtd build from this branch. I've now reverted that setting change after build completed.