Skip to content

Commit 68c7c17

Browse files
jeremijeremi
committed
docs: regenerate README files for new modules
Regenerate auto-generated README and index.html files for spp_gis_indicators, spp_hxl, spp_hxl_area, spp_registrant_gis, and spp_simulation to fix pre-commit oca-gen-addon-readme hook.
1 parent a72ada0 commit 68c7c17

File tree

10 files changed

+81
-137
lines changed

10 files changed

+81
-137
lines changed

‎spp_gis_indicators/README.rst‎

Lines changed: 2 additions & 7 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 GIS Indicators
73
======================
84

9-
..
5+
..
106
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
117
!! This file is generated by oca-gen-addon-readme !!
128
!! changes will be overwritten. !!
@@ -114,7 +110,6 @@ Dependencies
114110
.. IMPORTANT::
115111
This is an alpha version, the data model and design can change at any time without warning.
116112
Only for development or testing purpose, do not use in production.
117-
`More details on development status <https://odoo-community.org/page/development-status>`_
118113

119114
**Table of contents**
120115

@@ -144,4 +139,4 @@ Maintainers
144139

145140
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_gis_indicators>`_ project on GitHub.
146141

147-
You are welcome to contribute.
142+
You are welcome to contribute.

‎spp_gis_indicators/static/description/index.html‎

Lines changed: 15 additions & 22 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 GIS Indicators</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-gis-indicators">
364+
<h1 class="title">OpenSPP GIS Indicators</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-gis-indicators">
370-
<h1>OpenSPP GIS Indicators</h1>
371366
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
372367
!! This file is generated by oca-gen-addon-readme !!
373368
!! changes will be overwritten. !!
@@ -381,7 +376,7 @@ <h1>OpenSPP GIS Indicators</h1>
381376
quantile, equal interval, and manual break classification with automatic
382377
legend generation.</p>
383378
<div class="section" id="key-capabilities">
384-
<h2>Key Capabilities</h2>
379+
<h1>Key Capabilities</h1>
385380
<ul class="simple">
386381
<li>Define indicator layer configurations that link CEL variables to color
387382
scales and classification methods</li>
@@ -397,7 +392,7 @@ <h2>Key Capabilities</h2>
397392
</ul>
398393
</div>
399394
<div class="section" id="key-models">
400-
<h2>Key Models</h2>
395+
<h1>Key Models</h1>
401396
<table border="1" class="docutils">
402397
<colgroup>
403398
<col width="42%" />
@@ -426,7 +421,7 @@ <h2>Key Models</h2>
426421
</table>
427422
</div>
428423
<div class="section" id="configuration">
429-
<h2>Configuration</h2>
424+
<h1>Configuration</h1>
430425
<p>After installing:</p>
431426
<ol class="arabic simple">
432427
<li>Navigate to <strong>Settings &gt; GIS Configuration &gt; Color Scales</strong></li>
@@ -440,14 +435,14 @@ <h2>Configuration</h2>
440435
</ol>
441436
</div>
442437
<div class="section" id="ui-location">
443-
<h2>UI Location</h2>
438+
<h1>UI Location</h1>
444439
<ul class="simple">
445440
<li><strong>Menu</strong>: Settings &gt; GIS Configuration &gt; Indicator Layers</li>
446441
<li><strong>Menu</strong>: Settings &gt; GIS Configuration &gt; Color Scales</li>
447442
</ul>
448443
</div>
449444
<div class="section" id="security">
450-
<h2>Security</h2>
445+
<h1>Security</h1>
451446
<table border="1" class="docutils">
452447
<colgroup>
453448
<col width="54%" />
@@ -472,7 +467,7 @@ <h2>Security</h2>
472467
</table>
473468
</div>
474469
<div class="section" id="extension-points">
475-
<h2>Extension Points</h2>
470+
<h1>Extension Points</h1>
476471
<ul class="simple">
477472
<li>Override <tt class="docutils literal">_compute_quantile_breaks()</tt> or
478473
<tt class="docutils literal">_compute_equal_interval_breaks()</tt> in <tt class="docutils literal">spp.gis.indicator.layer</tt> to
@@ -484,13 +479,12 @@ <h2>Extension Points</h2>
484479
</ul>
485480
</div>
486481
<div class="section" id="dependencies">
487-
<h2>Dependencies</h2>
482+
<h1>Dependencies</h1>
488483
<p><tt class="docutils literal">spp_gis</tt>, <tt class="docutils literal">spp_hxl_area</tt></p>
489484
<div class="admonition important">
490485
<p class="first admonition-title">Important</p>
491486
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
492-
Only for development or testing purpose, do not use in production.
493-
<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
487+
Only for development or testing purpose, do not use in production.</p>
494488
</div>
495489
<p><strong>Table of contents</strong></p>
496490
<div class="contents local topic" id="contents">
@@ -504,29 +498,28 @@ <h2>Dependencies</h2>
504498
</ul>
505499
</div>
506500
<div class="section" id="bug-tracker">
507-
<h3><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h3>
501+
<h2><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h2>
508502
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
509503
In case of trouble, please check there if your issue has already been reported.
510504
If you spotted it first, help us to smash it by providing a detailed and welcomed
511505
<a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_gis_indicators%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
512506
<p>Do not contact contributors directly about support or help with technical issues.</p>
513507
</div>
514508
<div class="section" id="credits">
515-
<h3><a class="toc-backref" href="#toc-entry-2">Credits</a></h3>
509+
<h2><a class="toc-backref" href="#toc-entry-2">Credits</a></h2>
516510
<div class="section" id="authors">
517-
<h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
511+
<h3><a class="toc-backref" href="#toc-entry-3">Authors</a></h3>
518512
<ul class="simple">
519513
<li>OpenSPP.org</li>
520514
</ul>
521515
</div>
522516
<div class="section" id="maintainers">
523-
<h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
517+
<h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
524518
<p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_gis_indicators">OpenSPP/OpenSPP2</a> project on GitHub.</p>
525519
<p>You are welcome to contribute.</p>
526520
</div>
527521
</div>
528522
</div>
529523
</div>
530-
</div>
531524
</body>
532525
</html>

‎spp_hxl/README.rst‎

Lines changed: 2 additions & 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
OpenSPP HXL Integration
73
=======================
84

9-
..
5+
..
106
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
117
!! This file is generated by oca-gen-addon-readme !!
128
!! changes will be overwritten. !!
@@ -173,4 +169,4 @@ Current maintainers:
173169

174170
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_hxl>`_ project on GitHub.
175171

176-
You are welcome to contribute.
172+
You are welcome to contribute.

‎spp_hxl/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 HXL Integration</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-hxl-integration">
364+
<h1 class="title">OpenSPP HXL Integration</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-hxl-integration">
370-
<h1>OpenSPP HXL Integration</h1>
371366
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
372367
!! This file is generated by oca-gen-addon-readme !!
373368
!! changes will be overwritten. !!
@@ -382,7 +377,7 @@ <h1>OpenSPP HXL Integration</h1>
382377
exchange data with humanitarian coordination systems using standardized
383378
HXL tagging conventions.</p>
384379
<div class="section" id="key-capabilities">
385-
<h2>Key Capabilities</h2>
380+
<h1>Key Capabilities</h1>
386381
<ul class="simple">
387382
<li>Registry of HXL 1.1 standard hashtags organized by category
388383
(geographic, population, activity, indicator, etc.)</li>
@@ -399,7 +394,7 @@ <h2>Key Capabilities</h2>
399394
</ul>
400395
</div>
401396
<div class="section" id="key-models">
402-
<h2>Key Models</h2>
397+
<h1>Key Models</h1>
403398
<table border="1" class="docutils">
404399
<colgroup>
405400
<col width="51%" />
@@ -436,7 +431,7 @@ <h2>Key Models</h2>
436431
</table>
437432
</div>
438433
<div class="section" id="configuration">
439-
<h2>Configuration</h2>
434+
<h1>Configuration</h1>
440435
<p>After installing:</p>
441436
<ol class="arabic simple">
442437
<li>Navigate to <strong>Custom &gt; HXL &gt; Configuration &gt; HXL Hashtags</strong> to view
@@ -461,7 +456,7 @@ <h2>Configuration</h2>
461456
</ol>
462457
</div>
463458
<div class="section" id="ui-location">
464-
<h2>UI Location</h2>
459+
<h1>UI Location</h1>
465460
<ul class="simple">
466461
<li><strong>Menu</strong>: Custom &gt; HXL (main menu)</li>
467462
<li><strong>Configuration</strong>: Custom &gt; HXL &gt; Configuration (HXL Hashtags, HXL
@@ -472,7 +467,7 @@ <h2>UI Location</h2>
472467
</ul>
473468
</div>
474469
<div class="section" id="security">
475-
<h2>Security</h2>
470+
<h1>Security</h1>
476471
<table border="1" class="docutils">
477472
<colgroup>
478473
<col width="78%" />
@@ -494,7 +489,7 @@ <h2>Security</h2>
494489
</table>
495490
</div>
496491
<div class="section" id="extension-points">
497-
<h2>Extension Points</h2>
492+
<h1>Extension Points</h1>
498493
<ul class="simple">
499494
<li>Inherit <tt class="docutils literal">spp.hxl.export.profile</tt> and override export logic to
500495
implement custom HXL export formats</li>
@@ -505,7 +500,7 @@ <h2>Extension Points</h2>
505500
</ul>
506501
</div>
507502
<div class="section" id="dependencies">
508-
<h2>Dependencies</h2>
503+
<h1>Dependencies</h1>
509504
<p><tt class="docutils literal">spp_security</tt>, <tt class="docutils literal">spp_cel_domain</tt>, <tt class="docutils literal">spp_studio</tt>, <tt class="docutils literal">spp_vocabulary</tt></p>
510505
<p><strong>Table of contents</strong></p>
511506
<div class="contents local topic" id="contents">
@@ -519,23 +514,23 @@ <h2>Dependencies</h2>
519514
</ul>
520515
</div>
521516
<div class="section" id="bug-tracker">
522-
<h3><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h3>
517+
<h2><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h2>
523518
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
524519
In case of trouble, please check there if your issue has already been reported.
525520
If you spotted it first, help us to smash it by providing a detailed and welcomed
526521
<a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_hxl%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
527522
<p>Do not contact contributors directly about support or help with technical issues.</p>
528523
</div>
529524
<div class="section" id="credits">
530-
<h3><a class="toc-backref" href="#toc-entry-2">Credits</a></h3>
525+
<h2><a class="toc-backref" href="#toc-entry-2">Credits</a></h2>
531526
<div class="section" id="authors">
532-
<h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
527+
<h3><a class="toc-backref" href="#toc-entry-3">Authors</a></h3>
533528
<ul class="simple">
534529
<li>OpenSPP.org</li>
535530
</ul>
536531
</div>
537532
<div class="section" id="maintainers">
538-
<h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
533+
<h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
539534
<p>Current maintainers:</p>
540535
<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>
541536
<p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_hxl">OpenSPP/OpenSPP2</a> project on GitHub.</p>
@@ -544,6 +539,5 @@ <h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
544539
</div>
545540
</div>
546541
</div>
547-
</div>
548542
</body>
549543
</html>

‎spp_hxl_area/README.rst‎

Lines changed: 2 additions & 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
OpenSPP HXL Area Integration
73
============================
84

9-
..
5+
..
106
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
117
!! This file is generated by oca-gen-addon-readme !!
128
!! changes will be overwritten. !!
@@ -166,4 +162,4 @@ Current maintainers:
166162

167163
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_hxl_area>`_ project on GitHub.
168164

169-
You are welcome to contribute.
165+
You are welcome to contribute.

0 commit comments

Comments
 (0)