Skip to content

Fix Sphinx 7.x compatibility in poster directive#97

Merged
pbrezina merged 1 commit intoSSSD:masterfrom
ikerexxe:fix-ci
Dec 12, 2025
Merged

Fix Sphinx 7.x compatibility in poster directive#97
pbrezina merged 1 commit intoSSSD:masterfrom
ikerexxe:fix-ci

Conversation

@ikerexxe
Copy link
Contributor

@ikerexxe ikerexxe commented Dec 12, 2025

Update render_partial() key access from 'html_body' to 'fragment' for Sphinx 7.x while maintaining backward compatibility with older versions.

@gemini-code-assist
Copy link

gemini-code-assist bot commented Dec 12, 2025

Summary of Changes

Hello @ikerexxe, 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 resolves a compatibility issue with Sphinx 7.x within the poster directive by modifying the node_to_html utility function. The change introduces a flexible approach to extract rendered HTML content, first attempting to use the 'fragment' key (introduced in Sphinx 7.x) and then falling back to the 'html_body' key for older Sphinx versions. This ensures the directive continues to function correctly across different Sphinx environments without breaking existing implementations.

Highlights

  • Sphinx 7.x Compatibility: Updated the node_to_html function to support Sphinx 7.x by checking for the 'fragment' key in the builder.render_partial() output.
  • Backward Compatibility: Ensured backward compatibility with older Sphinx versions by falling back to the 'html_body' key if 'fragment' is not present.
  • Robust Error Handling: Added a KeyError to catch cases where neither 'fragment' nor 'html_body' is found, providing clearer debugging information.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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[bot]
gemini-code-assist bot reviewed Dec 12, 2025
View reviewed changes
Copy link

@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 compatibility with Sphinx 7.x by modifying how rendered HTML partials are accessed. The change correctly checks for the new 'fragment' key while maintaining backward compatibility with the older 'html_body' key. The implementation is sound and includes appropriate error handling. I have provided one suggestion to refactor the key-checking logic to be more idiomatic and maintainable.

@ikerexxe @claude
Fix Sphinx 7.x compatibility in poster directive
1679014 
Update render_partial() key access from 'html_body' to 'fragment' for
Sphinx 7.x while maintaining backward compatibility with older versions.

Co-Authored-By: Claude Sonnet 4 <noreply@anthropic.com>
Signed-off-by: Iker Pedrosa <ipedrosa@redhat.com>
@ikerexxe ikerexxe mentioned this pull request Dec 12, 2025
Merged
@pbrezina pbrezina merged commit b31b14e into SSSD:master Dec 12, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pbrezina pbrezina pbrezina approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ikerexxe @pbrezina