chore: regenerate all READMEs with Python 3.11 to match CI#94
chore: regenerate all READMEs with Python 3.11 to match CI#94
Conversation
CI pre-commit uses Python 3.11. The docutils library produces slightly different HTML output between Python 3.11 and 3.12 (column widths, text wrapping). This one-time regeneration aligns all auto-generated files with CI to prevent pre-commit failures on future PRs.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 19.0 #94 +/- ##
==========================================
+ Coverage 70.39% 70.65% +0.25%
==========================================
Files 674 697 +23
Lines 37005 38304 +1299
==========================================
+ Hits 26051 27063 +1012
- Misses 10954 11241 +287
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
Closing — READMEs were regenerated without the custom template flag, which brought back the OCA banner. Will redo correctly. |
Summary of ChangesHello, 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 synchronizes the auto-generated documentation files across the repository with the Python 3.11 environment used in continuous integration. The previous generation using Python 3.12 led to minor formatting discrepancies in the HTML output, causing pre-commit checks to fail. By regenerating these files with the correct Python version, we ensure that future contributions will pass CI without unexpected documentation diffs. Highlights
Changelog
Activity
Using Gemini Code AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request regenerates all README files using Python 3.11 to align with the CI environment. The changes primarily consist of formatting adjustments in .rst and .html files, such as table column widths, text wrapping, and heading structures, which are expected from the docutils library version change. I've identified a minor regression in all generated index.html files where the page title is set to "README.rst" instead of the more descriptive addon name. I've left a specific comment on one file to address this, which should be applied across all similar files. Apart from this, the changes are consistent with the goal of the pull request.
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
| <meta name="generator" content="Docutils: https://docutils.sourceforge.io/" /> | ||
| <title>Endpoint route handler</title> | ||
| <title>README.rst</title> |
There was a problem hiding this comment.
The page title has been changed to README.rst, which is not descriptive for users viewing the page in a browser tab. It would be better to use the addon name as the title, as it was before (Endpoint route handler). This seems to be a regression in the oca-gen-addon-readme tool and should be corrected for a better user experience. This issue is present in all generated index.html files in this pull request.
| <title>README.rst</title> | |
| <title>Endpoint route handler</title> |
1 participant
Why is this change needed?
CI pre-commit workflow uses Python 3.11, but these auto-generated files were committed using Python 3.12. The
docutilslibrary produces slightly different HTML between versions (column widths, text wrapping in tables), causing every PR to fail the pre-commit check.How was the change implemented?
Ran
oca-gen-addon-readmeunder Python 3.11 to regenerate allREADME.rstandstatic/description/index.htmlfiles. This is a one-time alignment — future PRs will pass pre-commit as long as contributors use Python 3.11 for the OCA readme generator.New unit tests
Unit tests executed by the author
How to test manually
Related links