Skip to content

Commit 315d426

Browse files
emjay0921emjay0921
committed
chore: regenerate all README.rst and index.html with Python 3.11
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.
1 parent 839f83e commit 315d426

172 files changed

Lines changed: 4755 additions & 3666 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎endpoint_route_handler/README.rst‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1+
.. image:: https://odoo-community.org/readme-banner-image
2+
:target: https://odoo-community.org/get-involved?utm_source=readme
3+
:alt: Odoo Community Association
4+
15
======================
26
Endpoint route handler
37
======================
48

5-
..
9+
..
610
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
711
!! This file is generated by oca-gen-addon-readme !!
812
!! changes will be overwritten. !!
913
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10-
!! source digest: sha256:f1bbafdb63324c99e655951ded45c889ed1be7e02085110e989b4de600735624
14+
!! source digest: sha256:6921e749d3958eeb6be29d3adb3782f76eaadba47124722da6bc9e292dfeb9d7
1115
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1216
1317
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
@@ -30,6 +34,7 @@ Can be used as a mixin or as a tool.
3034
.. IMPORTANT::
3135
This is an alpha version, the data model and design can change at any time without warning.
3236
Only for development or testing purpose, do not use in production.
37+
`More details on development status <https://odoo-community.org/page/development-status>`_
3338

3439
**Table of contents**
3540

@@ -181,4 +186,4 @@ Current maintainer:
181186

182187
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/endpoint_route_handler>`_ project on GitHub.
183188

184-
You are welcome to contribute.
189+
You are welcome to contribute.

‎endpoint_route_handler/static/description/index.html‎

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
55
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
6-
<title>Endpoint route handler</title>
6+
<title>README.rst</title>
77
<style type="text/css">
88

99
/*
@@ -360,14 +360,19 @@
360360
</style>
361361
</head>
362362
<body>
363-
<div class="document" id="endpoint-route-handler">
364-
<h1 class="title">Endpoint route handler</h1>
363+
<div class="document">
365364

365+
366+
<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
367+
<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
368+
</a>
369+
<div class="section" id="endpoint-route-handler">
370+
<h1>Endpoint route handler</h1>
366371
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372
!! This file is generated by oca-gen-addon-readme !!
368373
!! changes will be overwritten. !!
369374
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370-
!! source digest: sha256:f1bbafdb63324c99e655951ded45c889ed1be7e02085110e989b4de600735624
375+
!! source digest: sha256:6921e749d3958eeb6be29d3adb3782f76eaadba47124722da6bc9e292dfeb9d7
371376
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372377
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/endpoint_route_handler"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
373378
<p>Technical module that provides a base handler for adding and removing
@@ -376,7 +381,8 @@ <h1 class="title">Endpoint route handler</h1>
376381
<div class="admonition important">
377382
<p class="first admonition-title">Important</p>
378383
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
379-
Only for development or testing purpose, do not use in production.</p>
384+
Only for development or testing purpose, do not use in production.
385+
<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
380386
</div>
381387
<p><strong>Table of contents</strong></p>
382388
<div class="contents local topic" id="contents">
@@ -397,9 +403,9 @@ <h1 class="title">Endpoint route handler</h1>
397403
</ul>
398404
</div>
399405
<div class="section" id="usage">
400-
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
406+
<h2><a class="toc-backref" href="#toc-entry-1">Usage</a></h2>
401407
<div class="section" id="as-a-mixin">
402-
<h2><a class="toc-backref" href="#toc-entry-2">As a mixin</a></h2>
408+
<h3><a class="toc-backref" href="#toc-entry-2">As a mixin</a></h3>
403409
<p>Use standard Odoo inheritance:</p>
404410
<pre class="literal-block">
405411
class MyModel(models.Model):
@@ -424,7 +430,7 @@ <h2><a class="toc-backref" href="#toc-entry-2">As a mixin</a></h2>
424430
record.</p>
425431
</div>
426432
<div class="section" id="as-a-tool">
427-
<h2><a class="toc-backref" href="#toc-entry-3">As a tool</a></h2>
433+
<h3><a class="toc-backref" href="#toc-entry-3">As a tool</a></h3>
428434
<p>Initialize non stored route handlers and generate routes from them. For
429435
instance:</p>
430436
<pre class="literal-block">
@@ -459,7 +465,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">As a tool</a></h2>
459465
</div>
460466
</div>
461467
<div class="section" id="known-issues-roadmap">
462-
<h1><a class="toc-backref" href="#toc-entry-4">Known issues / Roadmap</a></h1>
468+
<h2><a class="toc-backref" href="#toc-entry-4">Known issues / Roadmap</a></h2>
463469
<ul>
464470
<li><p class="first">add api docs helpers</p>
465471
</li>
@@ -489,36 +495,37 @@ <h1><a class="toc-backref" href="#toc-entry-4">Known issues / Roadmap</a></h1>
489495
routing info.</p>
490496
</div>
491497
<div class="section" id="bug-tracker">
492-
<h1><a class="toc-backref" href="#toc-entry-5">Bug Tracker</a></h1>
498+
<h2><a class="toc-backref" href="#toc-entry-5">Bug Tracker</a></h2>
493499
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
494500
In case of trouble, please check there if your issue has already been reported.
495501
If you spotted it first, help us to smash it by providing a detailed and welcomed
496502
<a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20endpoint_route_handler%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
497503
<p>Do not contact contributors directly about support or help with technical issues.</p>
498504
</div>
499505
<div class="section" id="credits">
500-
<h1><a class="toc-backref" href="#toc-entry-6">Credits</a></h1>
506+
<h2><a class="toc-backref" href="#toc-entry-6">Credits</a></h2>
501507
<div class="section" id="authors">
502-
<h2><a class="toc-backref" href="#toc-entry-7">Authors</a></h2>
508+
<h3><a class="toc-backref" href="#toc-entry-7">Authors</a></h3>
503509
<ul class="simple">
504510
<li>Camptocamp</li>
505511
</ul>
506512
</div>
507513
<div class="section" id="contributors">
508-
<h2><a class="toc-backref" href="#toc-entry-8">Contributors</a></h2>
514+
<h3><a class="toc-backref" href="#toc-entry-8">Contributors</a></h3>
509515
<ul class="simple">
510516
<li>Simone Orsi &lt;<a class="reference external" href="mailto:simone.orsi&#64;camptocamp.com">simone.orsi&#64;camptocamp.com</a>&gt;</li>
511517
<li>Nguyen Minh Chien &lt;<a class="reference external" href="mailto:chien&#64;trobz.com">chien&#64;trobz.com</a>&gt;</li>
512518
</ul>
513519
</div>
514520
<div class="section" id="maintainers">
515-
<h2><a class="toc-backref" href="#toc-entry-9">Maintainers</a></h2>
521+
<h3><a class="toc-backref" href="#toc-entry-9">Maintainers</a></h3>
516522
<p>Current maintainer:</p>
517523
<p><a class="reference external image-reference" href="https://github.com/simahawk"><img alt="simahawk" src="https://github.com/simahawk.png?size=40px" /></a></p>
518524
<p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/endpoint_route_handler">OpenSPP/OpenSPP2</a> project on GitHub.</p>
519525
<p>You are welcome to contribute.</p>
520526
</div>
521527
</div>
522528
</div>
529+
</div>
523530
</body>
524531
</html>

‎spp_aggregation/README.rst‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
.. image:: https://odoo-community.org/readme-banner-image
2+
:target: https://odoo-community.org/get-involved?utm_source=readme
3+
:alt: Odoo Community Association
4+
15
==========================
26
OpenSPP Aggregation Engine
37
==========================
48

5-
..
9+
..
610
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
711
!! This file is generated by oca-gen-addon-readme !!
812
!! changes will be overwritten. !!
@@ -143,4 +147,4 @@ Current maintainer:
143147

144148
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_aggregation>`_ project on GitHub.
145149

146-
You are welcome to contribute.
150+
You are welcome to contribute.

‎spp_alerts/README.rst‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1+
.. image:: https://odoo-community.org/readme-banner-image
2+
:target: https://odoo-community.org/get-involved?utm_source=readme
3+
:alt: Odoo Community Association
4+
15
==============
26
OpenSPP Alerts
37
==============
48

5-
..
9+
..
610
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
711
!! This file is generated by oca-gen-addon-readme !!
812
!! changes will be overwritten. !!
913
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10-
!! source digest: sha256:7186687b7752640f90d9d124b0fc91967afaef27e84c13f22cbed7954ae9b438
14+
!! source digest: sha256:bbe9aa22129eda9e74abcff88677f3e012fd237b043f1785081d213c6ed2c2fd
1115
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1216
1317
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -43,15 +47,15 @@ Key Capabilities
4347
Key Models
4448
~~~~~~~~~~
4549

46-
+--------------------+-------------------------------------------------+
47-
| Model | Description |
48-
+====================+=================================================+
49-
| ``spp.alert`` | Alert instance with state tracking and |
50-
| | resolution workflow |
51-
+--------------------+-------------------------------------------------+
52-
| ``spp.alert.rule`` | Rule configuration for monitoring criteria and |
53-
| | thresholds |
54-
+--------------------+-------------------------------------------------+
50+
+--------------------+------------------------------------------------+
51+
| Model | Description |
52+
+====================+================================================+
53+
| ``spp.alert`` | Alert instance with state tracking and |
54+
| | resolution workflow |
55+
+--------------------+------------------------------------------------+
56+
| ``spp.alert.rule`` | Rule configuration for monitoring criteria and |
57+
| | thresholds |
58+
+--------------------+------------------------------------------------+
5559

5660
Configuration
5761
~~~~~~~~~~~~~
@@ -141,4 +145,4 @@ Current maintainers:
141145

142146
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_alerts>`_ project on GitHub.
143147

144-
You are welcome to contribute.
148+
You are welcome to contribute.

‎spp_alerts/static/description/index.html‎

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
55
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
6-
<title>OpenSPP Alerts</title>
6+
<title>README.rst</title>
77
<style type="text/css">
88

99
/*
@@ -360,14 +360,19 @@
360360
</style>
361361
</head>
362362
<body>
363-
<div class="document" id="openspp-alerts">
364-
<h1 class="title">OpenSPP Alerts</h1>
363+
<div class="document">
365364

365+
366+
<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
367+
<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
368+
</a>
369+
<div class="section" id="openspp-alerts">
370+
<h1>OpenSPP Alerts</h1>
366371
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372
!! This file is generated by oca-gen-addon-readme !!
368373
!! changes will be overwritten. !!
369374
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370-
!! source digest: sha256:7186687b7752640f90d9d124b0fc91967afaef27e84c13f22cbed7954ae9b438
375+
!! source digest: sha256:bbe9aa22129eda9e74abcff88677f3e012fd237b043f1785081d213c6ed2c2fd
371376
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372377
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_alerts"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
373378
<p>Generic alert engine for threshold monitoring, expiry tracking, and
@@ -376,7 +381,7 @@ <h1 class="title">OpenSPP Alerts</h1>
376381
models and implement evaluation logic to generate alerts based on
377382
domain-specific conditions.</p>
378383
<div class="section" id="key-capabilities">
379-
<h1>Key Capabilities</h1>
384+
<h2>Key Capabilities</h2>
380385
<ul class="simple">
381386
<li>Track alert lifecycle through state machine: active → acknowledged →
382387
resolved</li>
@@ -389,7 +394,7 @@ <h1>Key Capabilities</h1>
389394
</ul>
390395
</div>
391396
<div class="section" id="key-models">
392-
<h1>Key Models</h1>
397+
<h2>Key Models</h2>
393398
<table border="1" class="docutils">
394399
<colgroup>
395400
<col width="29%" />
@@ -413,7 +418,7 @@ <h1>Key Models</h1>
413418
</table>
414419
</div>
415420
<div class="section" id="configuration">
416-
<h1>Configuration</h1>
421+
<h2>Configuration</h2>
417422
<p>After installing:</p>
418423
<ol class="arabic simple">
419424
<li>Navigate to <strong>Settings &gt; Technical &gt; Alerts &gt; Alert Rules</strong></li>
@@ -424,15 +429,15 @@ <h1>Configuration</h1>
424429
</ol>
425430
</div>
426431
<div class="section" id="ui-location">
427-
<h1>UI Location</h1>
432+
<h2>UI Location</h2>
428433
<ul class="simple">
429434
<li><strong>Menu</strong>: Settings &gt; Technical &gt; Alerts &gt; Alerts</li>
430435
<li><strong>Configuration</strong>: Settings &gt; Technical &gt; Alerts &gt; Alert Rules</li>
431436
<li><strong>Form Tabs</strong>: Details, Resolution (alerts); Thresholds (rules)</li>
432437
</ul>
433438
</div>
434439
<div class="section" id="security">
435-
<h1>Security</h1>
440+
<h2>Security</h2>
436441
<table border="1" class="docutils">
437442
<colgroup>
438443
<col width="49%" />
@@ -457,7 +462,7 @@ <h1>Security</h1>
457462
</table>
458463
</div>
459464
<div class="section" id="extension-points">
460-
<h1>Extension Points</h1>
465+
<h2>Extension Points</h2>
461466
<ul class="simple">
462467
<li>Inherit <tt class="docutils literal">spp.alert</tt> to add domain-specific fields (e.g., stock
463468
levels, document references)</li>
@@ -470,7 +475,7 @@ <h1>Extension Points</h1>
470475
</ul>
471476
</div>
472477
<div class="section" id="dependencies">
473-
<h1>Dependencies</h1>
478+
<h2>Dependencies</h2>
474479
<p><tt class="docutils literal">base</tt>, <tt class="docutils literal">mail</tt>, <tt class="docutils literal">spp_security</tt>, <tt class="docutils literal">spp_vocabulary</tt></p>
475480
<p><strong>Table of contents</strong></p>
476481
<div class="contents local topic" id="contents">
@@ -484,23 +489,23 @@ <h1>Dependencies</h1>
484489
</ul>
485490
</div>
486491
<div class="section" id="bug-tracker">
487-
<h2><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h2>
492+
<h3><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h3>
488493
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
489494
In case of trouble, please check there if your issue has already been reported.
490495
If you spotted it first, help us to smash it by providing a detailed and welcomed
491496
<a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_alerts%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
492497
<p>Do not contact contributors directly about support or help with technical issues.</p>
493498
</div>
494499
<div class="section" id="credits">
495-
<h2><a class="toc-backref" href="#toc-entry-2">Credits</a></h2>
500+
<h3><a class="toc-backref" href="#toc-entry-2">Credits</a></h3>
496501
<div class="section" id="authors">
497-
<h3><a class="toc-backref" href="#toc-entry-3">Authors</a></h3>
502+
<h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
498503
<ul class="simple">
499504
<li>OpenSPP.org</li>
500505
</ul>
501506
</div>
502507
<div class="section" id="maintainers">
503-
<h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
508+
<h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
504509
<p>Current maintainers:</p>
505510
<p><a class="reference external image-reference" href="https://github.com/jeremi"><img alt="jeremi" src="https://github.com/jeremi.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/gonzalesedwin1123"><img alt="gonzalesedwin1123" src="https://github.com/gonzalesedwin1123.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/emjay0921"><img alt="emjay0921" src="https://github.com/emjay0921.png?size=40px" /></a></p>
506511
<p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_alerts">OpenSPP/OpenSPP2</a> project on GitHub.</p>
@@ -509,5 +514,6 @@ <h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
509514
</div>
510515
</div>
511516
</div>
517+
</div>
512518
</body>
513519
</html>

0 commit comments

Comments
 (0)