Skip to content

Fix readthedocs build#632

Merged
yarikoptic merged 2 commits intomasterfrom
test-rtd-build
Sep 5, 2025
Merged

Fix readthedocs build#632
yarikoptic merged 2 commits intomasterfrom
test-rtd-build

Conversation

@asmacdo
Copy link
Member

@asmacdo asmacdo commented Sep 4, 2025

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.

Copy link
Contributor

@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.

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, specifying ubuntu-22.04 as the build OS and python: 3.12 as 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.txt and requirements-devel.txt, ensuring all necessary dependencies are installed for documentation generation.
  • Deprecated Dependency Removal: The pycrypto dependency, which is no longer maintained and has known security concerns, has been removed from the project's setup.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

  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.

Copy link
Contributor

@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 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.

@asmacdo
Copy link
Member Author

asmacdo commented Sep 4, 2025

Checked again with the gemini suggestion and docs build as expected

@asmacdo asmacdo force-pushed the test-rtd-build branch 2 times, most recently from b266539 to 7831c6d Compare September 4, 2025 22:33
@asmacdo asmacdo marked this pull request as draft September 4, 2025 22:34
@asmacdo asmacdo changed the title Test rtd build Fix readthedocs build Sep 4, 2025
@asmacdo asmacdo marked this pull request as ready for review September 4, 2025 22:39
@yarikoptic
Copy link
Member

I just now enabled
image

in https://app.readthedocs.org/dashboard/reproman/edit/ . Let's push smth useful and see if builds ok?

@asmacdo asmacdo mentioned this pull request Sep 5, 2025
3 tasks
@yarikoptic
Copy link
Member

build passes, so let's go

@yarikoptic yarikoptic merged commit 4892660 into master Sep 5, 2025
3 of 8 checks passed
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.

2 participants