Skip to content

Commit beed47d

Browse files
committed
docs(spp_mis_demo_v2,spp_farmer_registry_demo): regenerate READMEs with custom template, remove OCA banner
1 parent beeb977 commit beed47d

File tree

4 files changed

+46
-66
lines changed

4 files changed

+46
-66
lines changed

spp_farmer_registry_demo/README.rst

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
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 Farmer Registry Demo
73
============================
84

9-
..
5+
..
106
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
117
!! This file is generated by oca-gen-addon-readme !!
128
!! changes will be overwritten. !!
139
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
14-
!! source digest: sha256:dfca553e48db1d9dfc3054a44bbbd863e95bc030a1dc4d389285d1b660f043c1
10+
!! source digest: sha256:force_regen
1511
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1612
1713
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
@@ -57,12 +53,12 @@ Key Capabilities
5753
Key Models
5854
~~~~~~~~~~
5955

60-
+-------------------------------+-------------------------------------+
61-
| Model | Description |
62-
+===============================+=====================================+
63-
| ``spp.farmer.demo.generator`` | Core demo generator wizard with all |
64-
| | generation logic |
65-
+-------------------------------+-------------------------------------+
56+
+-------------------------------+--------------------------------------+
57+
| Model | Description |
58+
+===============================+======================================+
59+
| ``spp.farmer.demo.generator`` | Core demo generator wizard with all |
60+
| | generation logic |
61+
+-------------------------------+--------------------------------------+
6662

6763
Configuration
6864
~~~~~~~~~~~~~
@@ -158,4 +154,4 @@ Current maintainers:
158154

159155
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_farmer_registry_demo>`_ project on GitHub.
160156

161-
You are welcome to contribute.
157+
You are welcome to contribute.

spp_farmer_registry_demo/static/description/index.html

Lines changed: 17 additions & 23 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 Farmer Registry Demo</title>
77
<style type="text/css">
88

99
/*
@@ -360,19 +360,14 @@
360360
</style>
361361
</head>
362362
<body>
363-
<div class="document">
363+
<div class="document" id="openspp-farmer-registry-demo">
364+
<h1 class="title">OpenSPP Farmer Registry Demo</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-farmer-registry-demo">
370-
<h1>OpenSPP Farmer Registry Demo</h1>
371366
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
372367
!! This file is generated by oca-gen-addon-readme !!
373368
!! changes will be overwritten. !!
374369
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
375-
!! source digest: sha256:dfca553e48db1d9dfc3054a44bbbd863e95bc030a1dc4d389285d1b660f043c1
370+
!! source digest: sha256:force_regen
376371
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
377372
<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_farmer_registry_demo"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
378373
<p>Demo data generator for the OpenSPP Farmer Registry. Creates 8 named
@@ -381,7 +376,7 @@ <h1>OpenSPP Farmer Registry Demo</h1>
381376
generates ~730 volume farms from deterministic blueprints using a seeded
382377
random generator (<tt class="docutils literal">seed=42</tt>) for reproducible output.</p>
383378
<div class="section" id="key-capabilities">
384-
<h2>Key Capabilities</h2>
379+
<h1>Key Capabilities</h1>
385380
<ul class="simple">
386381
<li><strong>8 Fixed Story Farms</strong> with hardcoded profiles (Maria Santos, Juan
387382
Dela Cruz, Rosa Garcia, Amir Mangudadatu, Sofia Martinez, Ramon dela
@@ -404,11 +399,11 @@ <h2>Key Capabilities</h2>
404399
</ul>
405400
</div>
406401
<div class="section" id="key-models">
407-
<h2>Key Models</h2>
402+
<h1>Key Models</h1>
408403
<table border="1" class="docutils">
409404
<colgroup>
410-
<col width="46%" />
411-
<col width="54%" />
405+
<col width="45%" />
406+
<col width="55%" />
412407
</colgroup>
413408
<thead valign="bottom">
414409
<tr><th class="head">Model</th>
@@ -424,15 +419,15 @@ <h2>Key Models</h2>
424419
</table>
425420
</div>
426421
<div class="section" id="configuration">
427-
<h2>Configuration</h2>
422+
<h1>Configuration</h1>
428423
<p>After installing:</p>
429424
<ol class="arabic simple">
430425
<li>Navigate to <strong>Settings &gt; Demo Data &gt; Load Farmer Demo</strong></li>
431426
<li>Click “Load Demo Data” to generate</li>
432427
</ol>
433428
</div>
434429
<div class="section" id="demo-programs">
435-
<h2>Demo Programs</h2>
430+
<h1>Demo Programs</h1>
436431
<p>All programs use CEL expressions with activated registry variables:</p>
437432
<ul class="simple">
438433
<li><strong>Input Subsidy Program</strong>: Per-hectare scaling for smallholders with
@@ -446,7 +441,7 @@ <h2>Demo Programs</h2>
446441
</ul>
447442
</div>
448443
<div class="section" id="seeded-volume-generation">
449-
<h2>Seeded Volume Generation</h2>
444+
<h1>Seeded Volume Generation</h1>
450445
<p>The <tt class="docutils literal">SeededFarmGenerator</tt> uses <tt class="docutils literal">random.Random(seed=42)</tt> for all
451446
structural choices:</p>
452447
<ul class="simple">
@@ -459,7 +454,7 @@ <h2>Seeded Volume Generation</h2>
459454
output.</p>
460455
</div>
461456
<div class="section" id="security">
462-
<h2>Security</h2>
457+
<h1>Security</h1>
463458
<table border="1" class="docutils">
464459
<colgroup>
465460
<col width="78%" />
@@ -478,7 +473,7 @@ <h2>Security</h2>
478473
</table>
479474
</div>
480475
<div class="section" id="dependencies">
481-
<h2>Dependencies</h2>
476+
<h1>Dependencies</h1>
482477
<p><tt class="docutils literal">spp_starter_farmer_registry</tt>, <tt class="docutils literal">spp_demo</tt>,
483478
<tt class="docutils literal">spp_farmer_registry_cr</tt>, <tt class="docutils literal">spp_studio</tt>,
484479
<tt class="docutils literal">spp_registry_group_hierarchy</tt>, <tt class="docutils literal">spp_area</tt>, <tt class="docutils literal">spp_programs</tt></p>
@@ -494,23 +489,23 @@ <h2>Dependencies</h2>
494489
</ul>
495490
</div>
496491
<div class="section" id="bug-tracker">
497-
<h3><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h3>
492+
<h2><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h2>
498493
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
499494
In case of trouble, please check there if your issue has already been reported.
500495
If you spotted it first, help us to smash it by providing a detailed and welcomed
501496
<a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_farmer_registry_demo%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
502497
<p>Do not contact contributors directly about support or help with technical issues.</p>
503498
</div>
504499
<div class="section" id="credits">
505-
<h3><a class="toc-backref" href="#toc-entry-2">Credits</a></h3>
500+
<h2><a class="toc-backref" href="#toc-entry-2">Credits</a></h2>
506501
<div class="section" id="authors">
507-
<h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
502+
<h3><a class="toc-backref" href="#toc-entry-3">Authors</a></h3>
508503
<ul class="simple">
509504
<li>OpenSPP.org</li>
510505
</ul>
511506
</div>
512507
<div class="section" id="maintainers">
513-
<h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
508+
<h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
514509
<p>Current maintainers:</p>
515510
<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>
516511
<p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_farmer_registry_demo">OpenSPP/OpenSPP2</a> project on GitHub.</p>
@@ -519,6 +514,5 @@ <h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
519514
</div>
520515
</div>
521516
</div>
522-
</div>
523517
</body>
524518
</html>

spp_mis_demo_v2/README.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
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 MIS Demo V2
73
===================
84

9-
..
5+
..
106
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
117
!! This file is generated by oca-gen-addon-readme !!
128
!! changes will be overwritten. !!
139
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
14-
!! source digest: sha256:fcd63f6ccdf525854e66ec8ffc304bd77b19da8056e6c5257bbfa4bc9c27c3ab
10+
!! source digest: sha256:force_regen
1511
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1612
1713
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
@@ -196,4 +192,4 @@ Current maintainers:
196192

197193
This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_mis_demo_v2>`_ project on GitHub.
198194

199-
You are welcome to contribute.
195+
You are welcome to contribute.

spp_mis_demo_v2/static/description/index.html

Lines changed: 17 additions & 23 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 MIS Demo V2</title>
77
<style type="text/css">
88

99
/*
@@ -360,19 +360,14 @@
360360
</style>
361361
</head>
362362
<body>
363-
<div class="document">
363+
<div class="document" id="openspp-mis-demo-v2">
364+
<h1 class="title">OpenSPP MIS Demo V2</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-mis-demo-v2">
370-
<h1>OpenSPP MIS Demo V2</h1>
371366
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
372367
!! This file is generated by oca-gen-addon-readme !!
373368
!! changes will be overwritten. !!
374369
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
375-
!! source digest: sha256:fcd63f6ccdf525854e66ec8ffc304bd77b19da8056e6c5257bbfa4bc9c27c3ab
370+
!! source digest: sha256:force_regen
376371
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
377372
<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_mis_demo_v2"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
378373
<p>Demo data generator for SP-MIS programs. Creates 7 social protection
@@ -382,7 +377,7 @@ <h1>OpenSPP MIS Demo V2</h1>
382377
data. Activates registry variables from <tt class="docutils literal">spp_studio</tt> and installs
383378
Logic Packs for eligibility rules.</p>
384379
<div class="section" id="key-capabilities">
385-
<h2>Key Capabilities</h2>
380+
<h1>Key Capabilities</h1>
386381
<ul class="simple">
387382
<li>Generate 7 programs (Universal Child Grant, Conditional Child Grant,
388383
Elderly Pension, Emergency Relief, Cash Transfer, Disability Support,
@@ -410,7 +405,7 @@ <h2>Key Capabilities</h2>
410405
</ul>
411406
</div>
412407
<div class="section" id="key-models">
413-
<h2>Key Models</h2>
408+
<h1>Key Models</h1>
414409
<table border="1" class="docutils">
415410
<colgroup>
416411
<col width="37%" />
@@ -432,7 +427,7 @@ <h2>Key Models</h2>
432427
</table>
433428
</div>
434429
<div class="section" id="configuration">
435-
<h2>Configuration</h2>
430+
<h1>Configuration</h1>
436431
<p>After installing:</p>
437432
<ol class="arabic simple">
438433
<li>Navigate to <strong>Settings &gt; Demo Data &gt; Load MIS Demo</strong></li>
@@ -447,7 +442,7 @@ <h2>Configuration</h2>
447442
</pre>
448443
</div>
449444
<div class="section" id="demo-programs">
450-
<h2>Demo Programs</h2>
445+
<h1>Demo Programs</h1>
451446
<p>All programs use CEL expressions with activated registry variables:</p>
452447
<ul class="simple">
453448
<li><strong>Universal Child Grant</strong>: <tt class="docutils literal">r.is_group == true and child_count &gt; 0</tt>
@@ -470,7 +465,7 @@ <h2>Demo Programs</h2>
470465
</ul>
471466
</div>
472467
<div class="section" id="seeded-volume-generation">
473-
<h2>Seeded Volume Generation</h2>
468+
<h1>Seeded Volume Generation</h1>
474469
<p>The <tt class="docutils literal">SeededVolumeGenerator</tt> uses <tt class="docutils literal">random.Random(seed=42)</tt> for all
475470
structural choices:</p>
476471
<ul class="simple">
@@ -486,15 +481,15 @@ <h2>Seeded Volume Generation</h2>
486481
output.</p>
487482
</div>
488483
<div class="section" id="ui-location">
489-
<h2>UI Location</h2>
484+
<h1>UI Location</h1>
490485
<ul class="simple">
491486
<li><strong>Menu</strong>: Settings &gt; Demo Data &gt; Load MIS Demo</li>
492487
<li><strong>Form</strong>: Wizard with generation options (demo mode, Logic Pack
493488
installation, volume data configuration)</li>
494489
</ul>
495490
</div>
496491
<div class="section" id="security">
497-
<h2>Security</h2>
492+
<h1>Security</h1>
498493
<table border="1" class="docutils">
499494
<colgroup>
500495
<col width="78%" />
@@ -513,7 +508,7 @@ <h2>Security</h2>
513508
</table>
514509
</div>
515510
<div class="section" id="extension-points">
516-
<h2>Extension Points</h2>
511+
<h1>Extension Points</h1>
517512
<ul class="simple">
518513
<li>Override <tt class="docutils literal">_create_demo_programs()</tt> to customize program definitions</li>
519514
<li>Override <tt class="docutils literal">_enroll_demo_stories()</tt> to modify enrollment logic</li>
@@ -522,7 +517,7 @@ <h2>Extension Points</h2>
522517
</ul>
523518
</div>
524519
<div class="section" id="dependencies">
525-
<h2>Dependencies</h2>
520+
<h1>Dependencies</h1>
526521
<p><tt class="docutils literal">spp_starter_sp_mis</tt>, <tt class="docutils literal">spp_cr_types_advanced</tt>, <tt class="docutils literal">spp_demo</tt>,
527522
<tt class="docutils literal">spp_gis_report</tt>, <tt class="docutils literal">spp_claim_169</tt></p>
528523
<p><strong>Table of contents</strong></p>
@@ -537,23 +532,23 @@ <h2>Dependencies</h2>
537532
</ul>
538533
</div>
539534
<div class="section" id="bug-tracker">
540-
<h3><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h3>
535+
<h2><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h2>
541536
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues">GitHub Issues</a>.
542537
In case of trouble, please check there if your issue has already been reported.
543538
If you spotted it first, help us to smash it by providing a detailed and welcomed
544539
<a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/issues/new?body=module:%20spp_mis_demo_v2%0Aversion:%2019.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
545540
<p>Do not contact contributors directly about support or help with technical issues.</p>
546541
</div>
547542
<div class="section" id="credits">
548-
<h3><a class="toc-backref" href="#toc-entry-2">Credits</a></h3>
543+
<h2><a class="toc-backref" href="#toc-entry-2">Credits</a></h2>
549544
<div class="section" id="authors">
550-
<h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
545+
<h3><a class="toc-backref" href="#toc-entry-3">Authors</a></h3>
551546
<ul class="simple">
552547
<li>OpenSPP.org</li>
553548
</ul>
554549
</div>
555550
<div class="section" id="maintainers">
556-
<h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
551+
<h3><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h3>
557552
<p>Current maintainers:</p>
558553
<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>
559554
<p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_mis_demo_v2">OpenSPP/OpenSPP2</a> project on GitHub.</p>
@@ -562,6 +557,5 @@ <h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
562557
</div>
563558
</div>
564559
</div>
565-
</div>
566560
</body>
567561
</html>

0 commit comments

Comments
 (0)