Skip to content

Commit 081bbfc

Browse files
emjay0921emjay0921
committed
chore: regenerate spp_security and spp_hazard READMEs with Python 3.11
1 parent be3716b commit 081bbfc

4 files changed

Lines changed: 56 additions & 36 deletions

File tree

‎spp_hazard/README.rst‎

Lines changed: 7 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
OpenSPP Hazard & Emergency Management
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:6c799a070608a2c41e92173cb6e13783cda3e3e01c784f1d94decc3c6391a182
14+
!! source digest: sha256:a8c431bd5b3d9af3ed97d2c211663e30be9d94121f66c6bb1f83369c1cfe43d3
1115
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1216
1317
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -172,4 +176,4 @@ Current maintainers:
172176

173177
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_hazard>`_ project on GitHub.
174178

175-
You are welcome to contribute.
179+
You are welcome to contribute.

‎spp_hazard/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 Hazard &amp; Emergency Management</title>
6+
<title>README.rst</title>
77
<style type="text/css">
88

99
/*
@@ -360,22 +360,27 @@
360360
</style>
361361
</head>
362362
<body>
363-
<div class="document" id="openspp-hazard-emergency-management">
364-
<h1 class="title">OpenSPP Hazard &amp; Emergency Management</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-hazard-emergency-management">
370+
<h1>OpenSPP Hazard &amp; Emergency Management</h1>
366371
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372
!! This file is generated by oca-gen-addon-readme !!
368373
!! changes will be overwritten. !!
369374
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370-
!! source digest: sha256:6c799a070608a2c41e92173cb6e13783cda3e3e01c784f1d94decc3c6391a182
375+
!! source digest: sha256:a8c431bd5b3d9af3ed97d2c211663e30be9d94121f66c6bb1f83369c1cfe43d3
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_hazard"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
373378
<p>Records disaster events and tracks their impact on individual
374379
registrants. Supports hierarchical hazard classification, geographic
375380
scope tracking, severity levels, and verification workflows to enable
376381
targeted emergency response and humanitarian assistance.</p>
377382
<div class="section" id="key-capabilities">
378-
<h1>Key Capabilities</h1>
383+
<h2>Key Capabilities</h2>
379384
<ul class="simple">
380385
<li>Define hazard categories in a tree structure (e.g., Natural &gt; Storm &gt;
381386
Typhoon)</li>
@@ -393,7 +398,7 @@ <h1>Key Capabilities</h1>
393398
</ul>
394399
</div>
395400
<div class="section" id="key-models">
396-
<h1>Key Models</h1>
401+
<h2>Key Models</h2>
397402
<table border="1" class="docutils">
398403
<colgroup>
399404
<col width="44%" />
@@ -433,7 +438,7 @@ <h1>Key Models</h1>
433438
</table>
434439
</div>
435440
<div class="section" id="configuration">
436-
<h1>Configuration</h1>
441+
<h2>Configuration</h2>
437442
<p>After installing:</p>
438443
<ol class="arabic simple">
439444
<li>Navigate to <strong>Hazard &amp; Emergency &gt; Configuration &gt; Hazard
@@ -446,7 +451,7 @@ <h1>Configuration</h1>
446451
</ol>
447452
</div>
448453
<div class="section" id="ui-location">
449-
<h1>UI Location</h1>
454+
<h2>UI Location</h2>
450455
<ul class="simple">
451456
<li><strong>Menu</strong>: Hazard &amp; Emergency (top-level application menu)</li>
452457
<li><strong>Incidents</strong>: Hazard &amp; Emergency &gt; Incidents &gt; All Incidents</li>
@@ -458,7 +463,7 @@ <h1>UI Location</h1>
458463
</ul>
459464
</div>
460465
<div class="section" id="security">
461-
<h1>Security</h1>
466+
<h2>Security</h2>
462467
<table border="1" class="docutils">
463468
<colgroup>
464469
<col width="50%" />
@@ -489,7 +494,7 @@ <h1>Security</h1>
489494
</table>
490495
</div>
491496
<div class="section" id="extension-points">
492-
<h1>Extension Points</h1>
497+
<h2>Extension Points</h2>
493498
<ul class="simple">
494499
<li>Inherit <tt class="docutils literal">spp.hazard.incident</tt> and override
495500
<tt class="docutils literal">identify_potentially_affected_registrants()</tt> to customize targeting
@@ -501,7 +506,7 @@ <h1>Extension Points</h1>
501506
</ul>
502507
</div>
503508
<div class="section" id="dependencies">
504-
<h1>Dependencies</h1>
509+
<h2>Dependencies</h2>
505510
<p><tt class="docutils literal">base</tt>, <tt class="docutils literal">spp_security</tt>, <tt class="docutils literal">spp_registry</tt>, <tt class="docutils literal">spp_area</tt></p>
506511
<p><strong>Table of contents</strong></p>
507512
<div class="contents local topic" id="contents">
@@ -515,23 +520,23 @@ <h1>Dependencies</h1>
515520
</ul>
516521
</div>
517522
<div class="section" id="bug-tracker">
518-
<h2><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h2>
523+
<h3><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h3>
519524
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
520525
In case of trouble, please check there if your issue has already been reported.
521526
If you spotted it first, help us to smash it by providing a detailed and welcomed
522527
<a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_hazard%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
523528
<p>Do not contact contributors directly about support or help with technical issues.</p>
524529
</div>
525530
<div class="section" id="credits">
526-
<h2><a class="toc-backref" href="#toc-entry-2">Credits</a></h2>
531+
<h3><a class="toc-backref" href="#toc-entry-2">Credits</a></h3>
527532
<div class="section" id="authors">
528-
<h3><a class="toc-backref" href="#toc-entry-3">Authors</a></h3>
533+
<h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
529534
<ul class="simple">
530535
<li>OpenSPP.org</li>
531536
</ul>
532537
</div>
533538
<div class="section" id="maintainers">
534-
<h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
539+
<h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
535540
<p>Current maintainers:</p>
536541
<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/reichie020212"><img alt="reichie020212" src="https://github.com/reichie020212.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>
537542
<p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_hazard">OpenSPP/OpenSPP2</a> project on GitHub.</p>
@@ -540,5 +545,6 @@ <h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
540545
</div>
541546
</div>
542547
</div>
548+
</div>
543549
</body>
544550
</html>

‎spp_security/README.rst‎

Lines changed: 7 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
OpenSPP Security
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:c840abe0695f0616775f34c46ab40c1e7bdf851d59940cc72b8ebcbba0860a30
14+
!! source digest: sha256:4e2e68cbd15f17068de9438997aa8a298a5d06d9b2578787860e2c88429c1247
1115
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1216
1317
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
@@ -171,4 +175,4 @@ Current maintainers:
171175

172176
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_security>`_ project on GitHub.
173177

174-
You are welcome to contribute.
178+
You are welcome to contribute.

‎spp_security/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 Security</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-security">
364-
<h1 class="title">OpenSPP Security</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-security">
370+
<h1>OpenSPP Security</h1>
366371
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372
!! This file is generated by oca-gen-addon-readme !!
368373
!! changes will be overwritten. !!
369374
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370-
!! source digest: sha256:c840abe0695f0616775f34c46ab40c1e7bdf851d59940cc72b8ebcbba0860a30
375+
!! source digest: sha256:4e2e68cbd15f17068de9438997aa8a298a5d06d9b2578787860e2c88429c1247
371376
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372377
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.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_security"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
373378
<p>Foundation security infrastructure for OpenSPP modules. Defines 22
@@ -376,7 +381,7 @@ <h1 class="title">OpenSPP Security</h1>
376381
privilege framework. Domain modules register their security groups
377382
within these predefined categories.</p>
378383
<div class="section" id="key-capabilities">
379-
<h1>Key Capabilities</h1>
384+
<h2>Key Capabilities</h2>
380385
<ul class="simple">
381386
<li>Define 22 domain-specific security categories (Registry, Programs,
382387
Entitlements, GRM, etc.) organizing security groups in user settings
@@ -393,14 +398,14 @@ <h1>Key Capabilities</h1>
393398
</ul>
394399
</div>
395400
<div class="section" id="configuration">
396-
<h1>Configuration</h1>
401+
<h2>Configuration</h2>
397402
<p>No configuration required. This module provides infrastructure only.
398403
When domain modules are installed, their security groups automatically
399404
appear under the appropriate category in <strong>Settings &gt; Users &amp; Companies
400405
&gt; Users</strong>.</p>
401406
</div>
402407
<div class="section" id="security">
403-
<h1>Security</h1>
408+
<h2>Security</h2>
404409
<p>This module defines no model access rights (empty
405410
<tt class="docutils literal">ir.model.access.csv</tt>). It provides only security groups and record
406411
rules.</p>
@@ -442,7 +447,7 @@ <h1>Security</h1>
442447
</ul>
443448
</div>
444449
<div class="section" id="extension-points">
445-
<h1>Extension Points</h1>
450+
<h2>Extension Points</h2>
446451
<p>Domain modules must follow this pattern to integrate with the security
447452
framework:</p>
448453
<ol class="arabic simple">
@@ -462,7 +467,7 @@ <h1>Extension Points</h1>
462467
</pre>
463468
</div>
464469
<div class="section" id="available-categories">
465-
<h1>Available Categories</h1>
470+
<h2>Available Categories</h2>
466471
<p>Administration: <tt class="docutils literal">category_spp_admin</tt></p>
467472
<p>Domain categories: <tt class="docutils literal">category_spp_registry</tt>, <tt class="docutils literal">category_spp_programs</tt>,
468473
<tt class="docutils literal">category_spp_scoring</tt>, <tt class="docutils literal">category_spp_entitlements</tt>,
@@ -478,14 +483,14 @@ <h1>Available Categories</h1>
478483
appear when domain modules install groups under them.</p>
479484
</div>
480485
<div class="section" id="architecture">
481-
<h1>Architecture</h1>
486+
<h2>Architecture</h2>
482487
<p>Categories are centrally defined in <tt class="docutils literal">spp_security</tt> but security groups
483488
are distributed to domain modules. This design ensures groups only exist
484489
when their domain module is installed, preventing UI clutter from unused
485490
permissions and enabling flexible installation combinations.</p>
486491
</div>
487492
<div class="section" id="dependencies">
488-
<h1>Dependencies</h1>
493+
<h2>Dependencies</h2>
489494
<p><tt class="docutils literal">base</tt></p>
490495
<p><strong>Table of contents</strong></p>
491496
<div class="contents local topic" id="contents">
@@ -499,23 +504,23 @@ <h1>Dependencies</h1>
499504
</ul>
500505
</div>
501506
<div class="section" id="bug-tracker">
502-
<h2><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h2>
507+
<h3><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h3>
503508
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
504509
In case of trouble, please check there if your issue has already been reported.
505510
If you spotted it first, help us to smash it by providing a detailed and welcomed
506511
<a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_security%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
507512
<p>Do not contact contributors directly about support or help with technical issues.</p>
508513
</div>
509514
<div class="section" id="credits">
510-
<h2><a class="toc-backref" href="#toc-entry-2">Credits</a></h2>
515+
<h3><a class="toc-backref" href="#toc-entry-2">Credits</a></h3>
511516
<div class="section" id="authors">
512-
<h3><a class="toc-backref" href="#toc-entry-3">Authors</a></h3>
517+
<h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
513518
<ul class="simple">
514519
<li>OpenSPP.org</li>
515520
</ul>
516521
</div>
517522
<div class="section" id="maintainers">
518-
<h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
523+
<h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
519524
<p>Current maintainers:</p>
520525
<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></p>
521526
<p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_security">OpenSPP/OpenSPP2</a> project on GitHub.</p>
@@ -524,5 +529,6 @@ <h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
524529
</div>
525530
</div>
526531
</div>
532+
</div>
527533
</body>
528534
</html>

0 commit comments

Comments
 (0)