Skip to content

Commit 136faa1

Browse files
jeremijeremi
committed
chore: regenerate addon READMEs and update readme template
1 parent 570e42f commit 136faa1

126 files changed

Lines changed: 943 additions & 1588 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: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
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-
51
======================
62
Endpoint route handler
73
======================
84

9-
..
5+
..
106
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
117
!! This file is generated by oca-gen-addon-readme !!
128
!! changes will be overwritten. !!
@@ -34,7 +30,6 @@ Can be used as a mixin or as a tool.
3430
.. IMPORTANT::
3531
This is an alpha version, the data model and design can change at any time without warning.
3632
Only for development or testing purpose, do not use in production.
37-
`More details on development status <https://odoo-community.org/page/development-status>`_
3833

3934
**Table of contents**
4035

‎endpoint_route_handler/static/description/index.html‎

Lines changed: 13 additions & 20 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>README.rst</title>
6+
<title>Endpoint route handler</title>
77
<style type="text/css">
88

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

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>
371366
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
372367
!! This file is generated by oca-gen-addon-readme !!
373368
!! changes will be overwritten. !!
@@ -381,8 +376,7 @@ <h1>Endpoint route handler</h1>
381376
<div class="admonition important">
382377
<p class="first admonition-title">Important</p>
383378
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
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>
379+
Only for development or testing purpose, do not use in production.</p>
386380
</div>
387381
<p><strong>Table of contents</strong></p>
388382
<div class="contents local topic" id="contents">
@@ -403,9 +397,9 @@ <h1>Endpoint route handler</h1>
403397
</ul>
404398
</div>
405399
<div class="section" id="usage">
406-
<h2><a class="toc-backref" href="#toc-entry-1">Usage</a></h2>
400+
<h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
407401
<div class="section" id="as-a-mixin">
408-
<h3><a class="toc-backref" href="#toc-entry-2">As a mixin</a></h3>
402+
<h2><a class="toc-backref" href="#toc-entry-2">As a mixin</a></h2>
409403
<p>Use standard Odoo inheritance:</p>
410404
<pre class="literal-block">
411405
class MyModel(models.Model):
@@ -430,7 +424,7 @@ <h3><a class="toc-backref" href="#toc-entry-2">As a mixin</a></h3>
430424
record.</p>
431425
</div>
432426
<div class="section" id="as-a-tool">
433-
<h3><a class="toc-backref" href="#toc-entry-3">As a tool</a></h3>
427+
<h2><a class="toc-backref" href="#toc-entry-3">As a tool</a></h2>
434428
<p>Initialize non stored route handlers and generate routes from them. For
435429
instance:</p>
436430
<pre class="literal-block">
@@ -465,7 +459,7 @@ <h3><a class="toc-backref" href="#toc-entry-3">As a tool</a></h3>
465459
</div>
466460
</div>
467461
<div class="section" id="known-issues-roadmap">
468-
<h2><a class="toc-backref" href="#toc-entry-4">Known issues / Roadmap</a></h2>
462+
<h1><a class="toc-backref" href="#toc-entry-4">Known issues / Roadmap</a></h1>
469463
<ul>
470464
<li><p class="first">add api docs helpers</p>
471465
</li>
@@ -495,37 +489,36 @@ <h2><a class="toc-backref" href="#toc-entry-4">Known issues / Roadmap</a></h2>
495489
routing info.</p>
496490
</div>
497491
<div class="section" id="bug-tracker">
498-
<h2><a class="toc-backref" href="#toc-entry-5">Bug Tracker</a></h2>
492+
<h1><a class="toc-backref" href="#toc-entry-5">Bug Tracker</a></h1>
499493
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
500494
In case of trouble, please check there if your issue has already been reported.
501495
If you spotted it first, help us to smash it by providing a detailed and welcomed
502496
<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>
503497
<p>Do not contact contributors directly about support or help with technical issues.</p>
504498
</div>
505499
<div class="section" id="credits">
506-
<h2><a class="toc-backref" href="#toc-entry-6">Credits</a></h2>
500+
<h1><a class="toc-backref" href="#toc-entry-6">Credits</a></h1>
507501
<div class="section" id="authors">
508-
<h3><a class="toc-backref" href="#toc-entry-7">Authors</a></h3>
502+
<h2><a class="toc-backref" href="#toc-entry-7">Authors</a></h2>
509503
<ul class="simple">
510504
<li>Camptocamp</li>
511505
</ul>
512506
</div>
513507
<div class="section" id="contributors">
514-
<h3><a class="toc-backref" href="#toc-entry-8">Contributors</a></h3>
508+
<h2><a class="toc-backref" href="#toc-entry-8">Contributors</a></h2>
515509
<ul class="simple">
516510
<li>Simone Orsi &lt;<a class="reference external" href="mailto:simone.orsi&#64;camptocamp.com">simone.orsi&#64;camptocamp.com</a>&gt;</li>
517511
<li>Nguyen Minh Chien &lt;<a class="reference external" href="mailto:chien&#64;trobz.com">chien&#64;trobz.com</a>&gt;</li>
518512
</ul>
519513
</div>
520514
<div class="section" id="maintainers">
521-
<h3><a class="toc-backref" href="#toc-entry-9">Maintainers</a></h3>
515+
<h2><a class="toc-backref" href="#toc-entry-9">Maintainers</a></h2>
522516
<p>Current maintainer:</p>
523517
<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>
524518
<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>
525519
<p>You are welcome to contribute.</p>
526520
</div>
527521
</div>
528522
</div>
529-
</div>
530523
</body>
531524
</html>

‎spp_alerts/README.rst‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
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-
51
==============
62
OpenSPP Alerts
73
==============
84

9-
..
5+
..
106
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
117
!! This file is generated by oca-gen-addon-readme !!
128
!! changes will be overwritten. !!

‎spp_alerts/static/description/index.html‎

Lines changed: 14 additions & 20 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>README.rst</title>
6+
<title>OpenSPP Alerts</title>
77
<style type="text/css">
88

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

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>
371366
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
372367
!! This file is generated by oca-gen-addon-readme !!
373368
!! changes will be overwritten. !!
@@ -381,7 +376,7 @@ <h1>OpenSPP Alerts</h1>
381376
models and implement evaluation logic to generate alerts based on
382377
domain-specific conditions.</p>
383378
<div class="section" id="key-capabilities">
384-
<h2>Key Capabilities</h2>
379+
<h1>Key Capabilities</h1>
385380
<ul class="simple">
386381
<li>Track alert lifecycle through state machine: active → acknowledged →
387382
resolved</li>
@@ -394,7 +389,7 @@ <h2>Key Capabilities</h2>
394389
</ul>
395390
</div>
396391
<div class="section" id="key-models">
397-
<h2>Key Models</h2>
392+
<h1>Key Models</h1>
398393
<table border="1" class="docutils">
399394
<colgroup>
400395
<col width="29%" />
@@ -418,7 +413,7 @@ <h2>Key Models</h2>
418413
</table>
419414
</div>
420415
<div class="section" id="configuration">
421-
<h2>Configuration</h2>
416+
<h1>Configuration</h1>
422417
<p>After installing:</p>
423418
<ol class="arabic simple">
424419
<li>Navigate to <strong>Settings &gt; Technical &gt; Alerts &gt; Alert Rules</strong></li>
@@ -429,15 +424,15 @@ <h2>Configuration</h2>
429424
</ol>
430425
</div>
431426
<div class="section" id="ui-location">
432-
<h2>UI Location</h2>
427+
<h1>UI Location</h1>
433428
<ul class="simple">
434429
<li><strong>Menu</strong>: Settings &gt; Technical &gt; Alerts &gt; Alerts</li>
435430
<li><strong>Configuration</strong>: Settings &gt; Technical &gt; Alerts &gt; Alert Rules</li>
436431
<li><strong>Form Tabs</strong>: Details, Resolution (alerts); Thresholds (rules)</li>
437432
</ul>
438433
</div>
439434
<div class="section" id="security">
440-
<h2>Security</h2>
435+
<h1>Security</h1>
441436
<table border="1" class="docutils">
442437
<colgroup>
443438
<col width="49%" />
@@ -462,7 +457,7 @@ <h2>Security</h2>
462457
</table>
463458
</div>
464459
<div class="section" id="extension-points">
465-
<h2>Extension Points</h2>
460+
<h1>Extension Points</h1>
466461
<ul class="simple">
467462
<li>Inherit <tt class="docutils literal">spp.alert</tt> to add domain-specific fields (e.g., stock
468463
levels, document references)</li>
@@ -475,7 +470,7 @@ <h2>Extension Points</h2>
475470
</ul>
476471
</div>
477472
<div class="section" id="dependencies">
478-
<h2>Dependencies</h2>
473+
<h1>Dependencies</h1>
479474
<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>
480475
<p><strong>Table of contents</strong></p>
481476
<div class="contents local topic" id="contents">
@@ -489,23 +484,23 @@ <h2>Dependencies</h2>
489484
</ul>
490485
</div>
491486
<div class="section" id="bug-tracker">
492-
<h3><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h3>
487+
<h2><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h2>
493488
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
494489
In case of trouble, please check there if your issue has already been reported.
495490
If you spotted it first, help us to smash it by providing a detailed and welcomed
496491
<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>
497492
<p>Do not contact contributors directly about support or help with technical issues.</p>
498493
</div>
499494
<div class="section" id="credits">
500-
<h3><a class="toc-backref" href="#toc-entry-2">Credits</a></h3>
495+
<h2><a class="toc-backref" href="#toc-entry-2">Credits</a></h2>
501496
<div class="section" id="authors">
502-
<h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
497+
<h3><a class="toc-backref" href="#toc-entry-3">Authors</a></h3>
503498
<ul class="simple">
504499
<li>OpenSPP.org</li>
505500
</ul>
506501
</div>
507502
<div class="section" id="maintainers">
508-
<h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
503+
<h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
509504
<p>Current maintainers:</p>
510505
<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>
511506
<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>
@@ -514,6 +509,5 @@ <h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
514509
</div>
515510
</div>
516511
</div>
517-
</div>
518512
</body>
519513
</html>

‎spp_api_v2/README.rst‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
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-
51
==============
62
OpenSPP API V2
73
==============
84

9-
..
5+
..
106
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
117
!! This file is generated by oca-gen-addon-readme !!
128
!! changes will be overwritten. !!

0 commit comments

Comments
 (0)