Skip to content

chore: regenerate all READMEs with Python 3.11 to match CI#95

Closed
emjay0921 wants to merge 2 commits into19.0from
fix/regenerate-readmes-python311
Closed

chore: regenerate all READMEs with Python 3.11 to match CI#95
emjay0921 wants to merge 2 commits into19.0from
fix/regenerate-readmes-python311

Conversation

@emjay0921
Copy link
Copy Markdown
Contributor

Why is this change needed?

CI pre-commit uses Python 3.11 but these auto-generated files were committed using Python 3.12. The docutils library produces slightly different HTML between versions (column widths, text wrapping), causing every PR to fail the pre-commit check.

How was the change implemented?

Ran oca-gen-addon-readme under Python 3.11 with the correct custom template (tools/readme_template.rst.jinja) to regenerate all README.rst and static/description/index.html files.

New unit tests

Unit tests executed by the author

How to test manually

  1. Create any PR after this is merged
  2. Pre-commit CI should pass without README diffs

Related links

CI pre-commit uses Python 3.11. The docutils library produces slightly
different HTML 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.
@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, 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 addresses a recurring issue in the continuous integration pipeline where pre-commit checks failed due to discrepancies in auto-generated documentation files. The root cause was identified as a difference in the Python version used for generating these files versus the version used in the CI environment. By regenerating all affected README.rst and static/description/index.html files with Python 3.11, the PR ensures that the documentation output is consistent with the CI's expectations, thereby resolving the pre-commit failures and maintaining a smooth development workflow.

Highlights

  • Documentation Regeneration: All auto-generated README.rst and static/description/index.html files were regenerated using Python 3.11.
  • CI Pre-commit Fix: This regeneration resolves pre-commit CI failures caused by docutils producing slightly different HTML output between Python 3.11 (used in CI) and Python 3.12 (previously used for generation).
  • Consistent Formatting: The changes primarily involve minor reformatting of table layouts, including adjustments to column widths and text wrapping within documentation files, ensuring consistency with the CI environment.
Changelog
  • spp_alerts/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_api_v2/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section.
  • spp_api_v2/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_api_v2_change_request/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_api_v2_change_request/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within a table cell for 'spp.registry.id'.
  • spp_api_v2_entitlements/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_api_v2_gis/README.rst
    • Reformatted table layout in 'API Endpoints' section, including line wrapping for long entries.
    • Reformatted table layout in 'Security' section, including line wrapping for long entries.
  • spp_api_v2_gis/static/description/index.html
    • Adjusted table column widths in 'API Endpoints' section.
    • Reformatted text wrapping and table structure for API endpoint paths.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping within a table cell for 'gis:geofence' scope.
  • spp_api_v2_products/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_api_v2_service_points/README.rst
    • Reformatted table layout in 'Extended Models' section.
  • spp_api_v2_service_points/static/description/index.html
    • Reformatted text wrapping within a table cell for 'fastapi.endpoint'.
  • spp_api_v2_vocabulary/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_api_v2_vocabulary/static/description/index.html
    • Reformatted text wrapping within a table cell for 'fastapi.endpoint'.
  • spp_approval/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_approval/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within a table cell for 'spp.approval.definition'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_area/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
  • spp_area/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.area.import.language.wizard'.
  • spp_area_hdx/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section.
  • spp_audit/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_audit/static/description/index.html
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for 'spp_audit.group_audit_manager'.
  • spp_banking/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_banking/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within a table cell for 'res.partner.bank'.
  • spp_base_common/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_branding_kit/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_case_base/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long descriptions.
  • spp_case_base/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within table cells for 'spp.case.intervention' and 'spp.case.note'.
  • spp_case_cel/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_case_cel/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_case_demo/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_case_demo/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_case_entitlements/README.rst
    • Reformatted table layout in 'Extended Models' section.
  • spp_case_entitlements/static/description/index.html
    • Adjusted table column widths in 'Extended Models' section.
    • Reformatted text wrapping within a table cell for 'spp.case'.
  • spp_case_graduation/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_case_graduation/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_case_programs/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_case_programs/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_case_registry/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_cel_domain/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long descriptions.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_cel_domain/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within table cells for 'spp.cel.variable.category' and 'spp.data.provider'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_cel_registry_search/README.rst
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_cel_registry_search/static/description/index.html
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_cel_widget/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section.
  • spp_cel_widget/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for 'spp.cel.widget.demo'.
  • spp_change_request_v2/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
    • Reformatted table layout in 'Extension Points' section.
    • Reformatted table layout in 'CEL Conditions' section, including line wrapping for long variable names.
    • Reformatted table layout in 'Methods Reference' section, including line wrapping for long method names.
    • Reformatted table layout in 'Related fields' section, including line wrapping for long field names.
    • Reformatted table layout in 'CR Type Fields Reference' section, including line wrapping for long field names.
  • spp_change_request_v2/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.change.request.type.mapping'.
    • Reformatted text wrapping and table structure for 'spp.cr.detail.edit_individual', 'spp.cr.detail.exit_registrant', 'spp.cr.detail.transfer_member', 'spp.cr.detail.merge_registrants', and 'spp.cr.detail.split_household'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
    • Reformatted text wrapping within a table cell for 'Field mappings'.
    • Adjusted table column widths in 'CEL Conditions' section.
    • Reformatted text wrapping and table structure for 'record.selected_field_name'.
    • Adjusted table column widths in 'Methods Reference' section.
    • Reformatted text wrapping and table structure for method names and return values.
    • Adjusted table column widths in 'Related fields' section.
    • Reformatted text wrapping and table structure for field names and sources.
    • Adjusted table column widths in 'CR Type Fields Reference' section.
    • Reformatted text wrapping and table structure for field names and descriptions.
  • spp_claim_169/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
    • Reformatted table layout in 'Security' section.
  • spp_consent/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_consent/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.bulk.record.consent.wizard'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_cr_types_advanced/README.rst
    • Reformatted table layout in 'Models Secured by This Module' section, including line wrapping for long model names.
  • spp_cr_types_advanced/static/description/index.html
    • Adjusted table column widths in 'Models Secured by This Module' section.
    • Reformatted text wrapping and table structure for model names.
  • spp_cr_types_base/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
    • Reformatted table layout in 'Security' section.
  • spp_cr_types_base/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.cr.detail.edit_individual' and 'spp.change.request.type.mapping'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_custom_field/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_custom_field/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_dci/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_dci/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_dci_client/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_dci_client/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_dci_client_crvs/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_dci_client_crvs/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_dci_client_dr/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long descriptions.
    • Reformatted table layout in 'Security' section.
  • spp_dci_client_dr/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within a table cell for 'spp.dci.disability.status'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping within a table cell for 'base.group_system'.
  • spp_dci_client_ibr/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_dci_client_ibr/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within table cells for 'spp.dci.ibr.sender' and 'fastapi.endpoint'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names and model names.
  • spp_dci_server/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_dci_server/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within a table cell for 'spp.dci.sender.registry'.
  • spp_demo/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_demo/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within a table cell for 'spp.demo.data.generator'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_dms/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section.
  • spp_dms/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.dms.restore.version.wizard'.
    • Adjusted table column widths in 'Security' section.
  • spp_drims/README.rst
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_drims/static/description/index.html
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_drims_sl/README.rst
    • Reformatted table layout in 'Approval Workflow Tiers' section.
  • spp_drims_sl_demo/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_drims_sl_demo/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_event_data/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_event_data/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within table cells for 'spp.event.field' and 'spp.event.type.mapping'.
  • spp_gis/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_gis/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for 'spp_registry.group_registry_read'.
  • spp_gis_report/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_gis_report/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within table cells for 'spp.gis.report', 'spp.gis.report.data', and 'spp.gis.report.category'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for 'spp_registry.group_registry_officer'.
  • spp_graduation/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_graduation/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.graduation.criteria.response'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_grm/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_grm/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_grm_case_link/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_grm_case_link/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_grm_cel/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long descriptions.
  • spp_grm_cel/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within a table cell for 'spp.grm.routing.rule'.
  • spp_grm_demo/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_grm_registry/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_hazard/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section.
  • spp_hazard/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within table cells for 'spp.hazard.category', 'spp.hazard.impact', and 'res.partner'.
    • Adjusted table column widths in 'Security' section.
  • spp_hazard_programs/README.rst
    • Removed Odoo Community Association banner image and related RST directives.
    • Removed trailing newline at end of file.
  • spp_hazard_programs/static/description/index.html
    • Updated HTML title from 'README.rst' to 'OpenSPP Hazard Programs Integration'.
    • Removed Odoo Community Association banner image and related HTML structure.
    • Changed 'Key Capabilities' heading from h2 to h1.
    • Changed 'Key Models' heading from h2 to h1.
    • Changed 'UI Location' heading from h2 to h1.
    • Changed 'Security' heading from h2 to h1.
    • Changed 'Extension Points' heading from h2 to h1.
    • Changed 'Dependencies' heading from h2 to h1.
    • Changed 'Bug Tracker' heading from h3 to h2.
    • Changed 'Credits' heading from h3 to h2.
    • Changed 'Authors' heading from h4 to h3.
    • Changed 'Maintainers' heading from h4 to h3.
    • Removed an extra closing div tag.
  • spp_hide_menus_base/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_hide_menus_base/static/description/index.html
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for 'spp_hide_menus_base.group_hide_menus_user'.
  • spp_hxl/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
  • spp_hxl/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.hxl.export.profile.column'.
  • spp_hxl_area/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section.
  • spp_hxl_area/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping within table cells for 'spp_security.group_spp_admin' and 'base.group_user'.
  • spp_import_match/README.rst
    • Removed Odoo Community Association banner image and related RST directives.
    • Removed trailing newline at end of file.
  • spp_import_match/static/description/index.html
    • Updated HTML title from 'README.rst' to 'OpenSPP Import Match'.
    • Removed Odoo Community Association banner image and related HTML structure.
    • Changed 'Key Capabilities' heading from h2 to h1.
    • Changed 'Key Models' heading from h2 to h1.
    • Changed 'Configuration' heading from h2 to h1.
    • Changed 'UI Location' heading from h2 to h1.
    • Changed 'Security' heading from h2 to h1.
    • Changed 'Extension Points' heading from h2 to h1.
    • Changed 'Dependencies' heading from h2 to h1.
    • Changed 'Bug Tracker' heading from h3 to h2.
    • Changed 'Credits' heading from h3 to h2.
    • Changed 'Authors' heading from h4 to h3.
    • Changed 'Maintainers' heading from h4 to h3.
    • Removed an extra closing div tag.
  • spp_key_management/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_key_management/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.key.provider.azure.keyvault'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_oauth/README.rst
    • Removed Odoo Community Association banner image and related RST directives.
    • Reformatted table layout in 'Utility Functions' section, including line wrapping for long function names.
    • Removed trailing newline at end of file.
  • spp_oauth/static/description/index.html
    • Updated HTML title from 'README.rst' to 'OpenSPP API: Oauth'.
    • Removed Odoo Community Association banner image and related HTML structure.
    • Changed 'Key Capabilities' heading from h2 to h1.
    • Changed 'Key Models' heading from h2 to h1.
    • Changed 'Utility Functions' heading from h2 to h1.
    • Reformatted text wrapping and table structure for 'verify_and_decode_signature()'.
    • Changed 'Configuration' heading from h2 to h1.
    • Changed 'UI Location' heading from h2 to h1.
    • Changed 'Security' heading from h2 to h1.
    • Changed 'Extension Points' heading from h2 to h1.
    • Changed 'Dependencies' heading from h2 to h1.
    • Changed 'Bug Tracker' heading from h3 to h2.
    • Changed 'Credits' heading from h3 to h2.
    • Changed 'Authors' heading from h4 to h3.
    • Changed 'Maintainers' heading from h4 to h3.
    • Removed an extra closing div tag.
  • spp_programs/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_programs/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for model names like 'spp.program.membership.manager', 'spp.program.membership.manager.default', 'spp.program.notification.manager', 'spp.program.entitlement.manager', 'spp.program.entitlement.manager.default', 'spp.program.entitlement.manager.cash', 'spp.program.entitlement.manager.inkind', 'spp.program.payment.manager.default', 'spp.compliance.manager.default', and 'spp.program.membership.duplicate'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_registry/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long descriptions.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_registry/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within a table cell for 'spp.registry.id'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_registry_search/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_registry_search/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_security/README.rst
    • Reformatted table layout in 'Security Groups' section, including line wrapping for long group names.
  • spp_security/static/description/index.html
    • Adjusted table column widths in 'Security Groups' section.
    • Reformatted text wrapping and table structure for 'Restricted: Self Only' group.
  • spp_service_points/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Extends' section.
  • spp_service_points/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Adjusted table column widths in 'Extends' section.
    • Reformatted text wrapping within table cells for 'res.partner' and 'res.users'.
  • spp_session_tracking/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_session_tracking/static/description/index.html
    • Reformatted text wrapping within a table cell for 'spp.session.type'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_simulation/README.rst
    • Reformatted table layout in 'Models' section, including line wrapping for long model names.
  • spp_simulation/static/description/index.html
    • Adjusted table column widths in 'Models' section.
    • Reformatted text wrapping and table structure for model names like 'spp.simulation.scenario.template' and 'spp.simulation.entitlement.rule'.
  • spp_source_tracking/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_source_tracking/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_starter_sp_mis/README.rst
    • Reformatted table layout in 'Key Models' section.
  • spp_starter_sp_mis/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
  • spp_studio/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_studio/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_studio_change_requests/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_studio_change_requests/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.studio.change.request.type'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_studio_events/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_studio_events/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for model names like 'spp.studio.event.field.template' and 'spp.studio.event.field.template.line'.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for security group names.
  • spp_user_roles/README.rst
    • Reformatted table layout in 'Key Models' section.
    • Reformatted table layout in 'Security' section, including line wrapping for long group names.
  • spp_user_roles/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Adjusted table column widths in 'Security' section.
    • Reformatted text wrapping and table structure for 'spp_user_roles.group_local_registrar'.
  • spp_versioning/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long model names.
  • spp_versioning/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping and table structure for 'spp.artifact.version.schedule.wizard'.
  • spp_vocabulary/README.rst
    • Reformatted table layout in 'Key Models' section, including line wrapping for long descriptions.
  • spp_vocabulary/static/description/index.html
    • Adjusted table column widths in 'Key Models' section.
    • Reformatted text wrapping within table cells for 'spp.vocabulary' and 'spp.deployment.profile'.
Activity
  • The author executed unit tests to verify the changes.
  • Manual testing steps were provided to confirm that pre-commit CI passes without README diffs after this merge.
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.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.51%. Comparing base (839f83e) to head (cd5312f).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             19.0      #95      +/-   ##
==========================================
+ Coverage   70.39%   70.51%   +0.11%     
==========================================
  Files         674      707      +33     
  Lines       37005    39125    +2120     
==========================================
+ Hits        26051    27590    +1539     
- Misses      10954    11535     +581     
Flag Coverage Δ
endpoint_route_handler 75.38% <ø> (?)
fastapi 84.21% <ø> (ø)
spp_aggregation 85.06% <ø> (ø)
spp_alerts 94.08% <ø> (ø)
spp_api_v2 79.96% <ø> (ø)
spp_api_v2_change_request 60.29% <ø> (ø)
spp_api_v2_cycles 71.12% <ø> (ø)
spp_api_v2_data 64.41% <ø> (ø)
spp_api_v2_entitlements 70.19% <ø> (ø)
spp_api_v2_gis 71.52% <ø> (ø)
spp_api_v2_products 66.27% <ø> (ø)
spp_api_v2_service_points 70.94% <ø> (ø)
spp_api_v2_simulation 69.61% <ø> (ø)
spp_api_v2_vocabulary 57.26% <ø> (ø)
spp_approval 50.29% <ø> (ø)
spp_area 79.26% <ø> (?)
spp_area_hdx 81.43% <ø> (ø)
spp_base_common 90.26% <ø> (ø)
spp_programs 45.51% <ø> (ø)
spp_security 66.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.
see 33 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown

@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 regenerates documentation files to align with the CI environment using Python 3.11. While the intent is clear and necessary for CI to pass, the regeneration process has introduced significant formatting issues in many of the README.rst files. Specifically, tables containing long lines with inline code are now incorrectly wrapped, leading to malformed reStructuredText that will not render correctly. I've added a specific comment highlighting one such instance, but the issue is widespread across the changed files. I recommend investigating and fixing the oca-gen-addon-readme tool or the custom template being used to resolve this systematic formatting problem before merging.

Comment on lines +109 to +110
| ` | Full CRUD on audit rules and |
| `spp_audit.group_audit_manager`` | logs |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The automatic regeneration of this file seems to have introduced a formatting issue in this table. The content of the first cell, ``spp_audit.group_audit_manager``, has been incorrectly wrapped across two lines, resulting in malformed reStructuredText with mismatched backticks. This will likely cause rendering issues.

This problem appears in many of the updated README.rst files in this pull request (e.g., in spp_approval/README.rst, spp_cel_domain/README.rst, spp_change_request_v2/README.rst, etc.). It would be best to fix the generation script to handle line wrapping within tables correctly before merging these changes, as the current state degrades the quality of the documentation.

@emjay0921 emjay0921 closed this Mar 12, 2026
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.

1 participant