Skip to content

Commit 47a6eaa

Browse files
emjay0921emjay0921
committed
fix: revert auto-generated README/index.html to 19.0 base versions
Reverts oca-gen-addon-readme output to match CI's version to avoid pre-commit failures from tool version differences.
1 parent fcde6f0 commit 47a6eaa

File tree

6 files changed

+83
-57
lines changed

6 files changed

+83
-57
lines changed

‎spp_hazard_programs/README.rst‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ OpenSPP Hazard Programs Integration
1010
!! source digest: sha256:e4ca3f5b5e8c998b833ccd6526f575c07f53a38ac49875511c31201f13122916
1111
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1212
13-
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
1414
:target: https://odoo-community.org/page/development-status
15-
:alt: Beta
15+
:alt: Alpha
1616
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
1717
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
1818
:alt: License: LGPL-3
@@ -44,15 +44,15 @@ Key Capabilities
4444
Key Models
4545
~~~~~~~~~~
4646

47-
+----------------------------------+----------------------------------+
48-
| Model | Description |
49-
+==================================+==================================+
50-
| ``spp.program`` (extend) | Adds target incidents, emergency |
51-
| | mode, damage filter |
52-
+----------------------------------+----------------------------------+
53-
| ``spp.hazard.incident`` (extend) | Adds reverse relation to |
54-
| | response programs |
55-
+----------------------------------+----------------------------------+
47+
+----------------------------------+-----------------------------------+
48+
| Model | Description |
49+
+==================================+===================================+
50+
| ``spp.program`` (extend) | Adds target incidents, emergency |
51+
| | mode, damage filter |
52+
+----------------------------------+-----------------------------------+
53+
| ``spp.hazard.incident`` (extend) | Adds reverse relation to response |
54+
| | programs |
55+
+----------------------------------+-----------------------------------+
5656

5757
UI Location
5858
~~~~~~~~~~~
@@ -89,6 +89,10 @@ Dependencies
8989

9090
``spp_hazard``, ``spp_programs``
9191

92+
.. IMPORTANT::
93+
This is an alpha version, the data model and design can change at any time without warning.
94+
Only for development or testing purpose, do not use in production.
95+
9296
**Table of contents**
9397

9498
.. contents::

‎spp_hazard_programs/static/description/index.html‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ <h1 class="title">OpenSPP Hazard Programs Integration</h1>
369369
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370370
!! source digest: sha256:e4ca3f5b5e8c998b833ccd6526f575c07f53a38ac49875511c31201f13122916
371371
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372-
<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_hazard_programs"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
372+
<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/spp_hazard_programs"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
373373
<p>Links hazard incidents to emergency response programs. Enables programs
374374
to target affected populations using verified impact data, filter
375375
registrants by damage severity, and automatically enable emergency mode
@@ -393,8 +393,8 @@ <h1>Key Capabilities</h1>
393393
<h1>Key Models</h1>
394394
<table border="1" class="docutils">
395395
<colgroup>
396-
<col width="50%" />
397-
<col width="50%" />
396+
<col width="49%" />
397+
<col width="51%" />
398398
</colgroup>
399399
<thead valign="bottom">
400400
<tr><th class="head">Model</th>
@@ -407,8 +407,8 @@ <h1>Key Models</h1>
407407
mode, damage filter</td>
408408
</tr>
409409
<tr><td><tt class="docutils literal">spp.hazard.incident</tt> (extend)</td>
410-
<td>Adds reverse relation to
411-
response programs</td>
410+
<td>Adds reverse relation to response
411+
programs</td>
412412
</tr>
413413
</tbody>
414414
</table>
@@ -448,6 +448,11 @@ <h1>Extension Points</h1>
448448
<div class="section" id="dependencies">
449449
<h1>Dependencies</h1>
450450
<p><tt class="docutils literal">spp_hazard</tt>, <tt class="docutils literal">spp_programs</tt></p>
451+
<div class="admonition important">
452+
<p class="first admonition-title">Important</p>
453+
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
454+
Only for development or testing purpose, do not use in production.</p>
455+
</div>
451456
<p><strong>Table of contents</strong></p>
452457
<div class="contents local topic" id="contents">
453458
<ul class="simple">

‎spp_import_match/README.rst‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ OpenSPP Import Match
1010
!! source digest: sha256:b57dea1315fd1f9af8f15720c5332b182c0a01fddd827a3daa73a8e950d41faa
1111
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1212
13-
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
1414
:target: https://odoo-community.org/page/development-status
15-
:alt: Beta
15+
:alt: Alpha
1616
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
1717
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
1818
:alt: License: LGPL-3
@@ -47,15 +47,15 @@ Key Capabilities
4747
Key Models
4848
~~~~~~~~~~
4949

50-
+-----------------------------+---------------------------------------+
51-
| Model | Description |
52-
+=============================+=======================================+
53-
| ``spp.import.match`` | Matching rule configuration for a |
54-
| | specific model |
55-
+-----------------------------+---------------------------------------+
56-
| ``spp.import.match.fields`` | Individual fields used in a rule, |
57-
| | supports sub-fields |
58-
+-----------------------------+---------------------------------------+
50+
+-----------------------------+----------------------------------------+
51+
| Model | Description |
52+
+=============================+========================================+
53+
| ``spp.import.match`` | Matching rule configuration for a |
54+
| | specific model |
55+
+-----------------------------+----------------------------------------+
56+
| ``spp.import.match.fields`` | Individual fields used in a rule, |
57+
| | supports sub-fields |
58+
+-----------------------------+----------------------------------------+
5959

6060
Configuration
6161
~~~~~~~~~~~~~
@@ -106,6 +106,10 @@ Dependencies
106106
``base``, ``spp_base_common``, ``base_import``, ``queue_job``,
107107
``spp_security``
108108

109+
.. IMPORTANT::
110+
This is an alpha version, the data model and design can change at any time without warning.
111+
Only for development or testing purpose, do not use in production.
112+
109113
**Table of contents**
110114

111115
.. contents::

‎spp_import_match/static/description/index.html‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ <h1 class="title">OpenSPP Import Match</h1>
369369
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370370
!! source digest: sha256:b57dea1315fd1f9af8f15720c5332b182c0a01fddd827a3daa73a8e950d41faa
371371
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372-
<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_import_match"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
372+
<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/spp_import_match"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
373373
<p>Extends Odoo’s base import functionality to match incoming records
374374
against existing data during bulk imports. Prevents duplicate creation
375375
by comparing imported rows to database records using configurable field
@@ -396,8 +396,8 @@ <h1>Key Capabilities</h1>
396396
<h1>Key Models</h1>
397397
<table border="1" class="docutils">
398398
<colgroup>
399-
<col width="43%" />
400-
<col width="57%" />
399+
<col width="42%" />
400+
<col width="58%" />
401401
</colgroup>
402402
<thead valign="bottom">
403403
<tr><th class="head">Model</th>
@@ -475,6 +475,11 @@ <h1>Extension Points</h1>
475475
<h1>Dependencies</h1>
476476
<p><tt class="docutils literal">base</tt>, <tt class="docutils literal">spp_base_common</tt>, <tt class="docutils literal">base_import</tt>, <tt class="docutils literal">queue_job</tt>,
477477
<tt class="docutils literal">spp_security</tt></p>
478+
<div class="admonition important">
479+
<p class="first admonition-title">Important</p>
480+
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
481+
Only for development or testing purpose, do not use in production.</p>
482+
</div>
478483
<p><strong>Table of contents</strong></p>
479484
<div class="contents local topic" id="contents">
480485
<ul class="simple">

‎spp_oauth/README.rst‎

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ OpenSPP API: Oauth
1010
!! source digest: sha256:25a909cff59dac7bf6fb0a36671aac5a2b03bbd13eda1b5085bde0c2f467c93f
1111
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1212
13-
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
1414
:target: https://odoo-community.org/page/development-status
15-
:alt: Beta
15+
:alt: Alpha
1616
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
1717
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
1818
:alt: License: LGPL-3
@@ -43,28 +43,28 @@ Key Capabilities
4343
Key Models
4444
~~~~~~~~~~
4545

46-
+-------------------------+-------------------------------------------+
47-
| Model | Description |
48-
+=========================+===========================================+
49-
| ``res.config.settings`` | Extended to add OAuth private and public |
50-
| | key fields |
51-
+-------------------------+-------------------------------------------+
46+
+-------------------------+--------------------------------------------+
47+
| Model | Description |
48+
+=========================+============================================+
49+
| ``res.config.settings`` | Extended to add OAuth private and public |
50+
| | key fields |
51+
+-------------------------+--------------------------------------------+
5252

5353
Utility Functions
5454
~~~~~~~~~~~~~~~~~
5555

56-
+----------------------------------+----------------------------------+
57-
| Function | Purpose |
58-
+==================================+==================================+
59-
| ``calculate_signature()`` | Encodes JWT with header and |
60-
| | payload using RS256 |
61-
+----------------------------------+----------------------------------+
62-
| ` | Decodes and verifies JWT token, |
63-
| `verify_and_decode_signature()`` | returns payload |
64-
+----------------------------------+----------------------------------+
65-
| ``OpenSPPOAuthJWTException`` | Custom exception for OAuth JWT |
66-
| | errors with logging |
67-
+----------------------------------+----------------------------------+
56+
+-----------------------------------+----------------------------------+
57+
| Function | Purpose |
58+
+===================================+==================================+
59+
| ``calculate_signature()`` | Encodes JWT with header and |
60+
| | payload using RS256 |
61+
+-----------------------------------+----------------------------------+
62+
| ``verify_and_decode_signature()`` | Decodes and verifies JWT token, |
63+
| | returns payload |
64+
+-----------------------------------+----------------------------------+
65+
| ``OpenSPPOAuthJWTException`` | Custom exception for OAuth JWT |
66+
| | errors with logging |
67+
+-----------------------------------+----------------------------------+
6868

6969
Configuration
7070
~~~~~~~~~~~~~
@@ -118,6 +118,10 @@ Dependencies
118118

119119
**External Python**: ``pyjwt>=2.4.0``
120120

121+
.. IMPORTANT::
122+
This is an alpha version, the data model and design can change at any time without warning.
123+
Only for development or testing purpose, do not use in production.
124+
121125
**Table of contents**
122126

123127
.. contents::

‎spp_oauth/static/description/index.html‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ <h1 class="title">OpenSPP API: Oauth</h1>
369369
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370370
!! source digest: sha256:25a909cff59dac7bf6fb0a36671aac5a2b03bbd13eda1b5085bde0c2f467c93f
371371
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372-
<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_oauth"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
372+
<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/spp_oauth"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
373373
<p>OAuth 2.0 authentication framework for securing OpenSPP API
374374
communications using JWT tokens signed with RSA keys. Provides utility
375375
functions to generate and verify JWT signatures using the RS256
@@ -392,8 +392,8 @@ <h1>Key Capabilities</h1>
392392
<h1>Key Models</h1>
393393
<table border="1" class="docutils">
394394
<colgroup>
395-
<col width="37%" />
396-
<col width="63%" />
395+
<col width="36%" />
396+
<col width="64%" />
397397
</colgroup>
398398
<thead valign="bottom">
399399
<tr><th class="head">Model</th>
@@ -412,8 +412,8 @@ <h1>Key Models</h1>
412412
<h1>Utility Functions</h1>
413413
<table border="1" class="docutils">
414414
<colgroup>
415-
<col width="50%" />
416-
<col width="50%" />
415+
<col width="51%" />
416+
<col width="49%" />
417417
</colgroup>
418418
<thead valign="bottom">
419419
<tr><th class="head">Function</th>
@@ -425,8 +425,7 @@ <h1>Utility Functions</h1>
425425
<td>Encodes JWT with header and
426426
payload using RS256</td>
427427
</tr>
428-
<tr><td>`
429-
<cite>verify_and_decode_signature()`</cite></td>
428+
<tr><td><tt class="docutils literal">verify_and_decode_signature()</tt></td>
430429
<td>Decodes and verifies JWT token,
431430
returns payload</td>
432431
</tr>
@@ -497,6 +496,11 @@ <h1>Extension Points</h1>
497496
<h1>Dependencies</h1>
498497
<p><tt class="docutils literal">spp_security</tt>, <tt class="docutils literal">base</tt></p>
499498
<p><strong>External Python</strong>: <tt class="docutils literal"><span class="pre">pyjwt&gt;=2.4.0</span></tt></p>
499+
<div class="admonition important">
500+
<p class="first admonition-title">Important</p>
501+
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
502+
Only for development or testing purpose, do not use in production.</p>
503+
</div>
500504
<p><strong>Table of contents</strong></p>
501505
<div class="contents local topic" id="contents">
502506
<ul class="simple">

0 commit comments

Comments
 (0)