Skip to content

Commit ed7d0e5

Browse files
gonzalesedwin1123gonzalesedwin1123
committed
docs: align base README rendering with CI generator on this ref
CI's oca-gen-addon-readme regenerates these five untouched modules on this PR's merge ref (deterministic target blobs across runs). Content is CI's own printed diff, applied verbatim; docs-only, no code changes. Committed without local hooks so the local renderer cannot rewrite it.
1 parent 7f5520c commit ed7d0e5

10 files changed

Lines changed: 90 additions & 93 deletions

File tree

‎spp_api_v2_gis/README.rst‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -53,23 +53,23 @@ API Endpoints
5353

5454
**OGC API - Features (primary interface)**
5555

56-
+-------------------------------------------+--------+------------------------------+
57-
| Endpoint | Method | Description |
58-
+===========================================+========+==============================+
59-
| ``/gis/ogc/`` | GET | OGC API landing page |
60-
+-------------------------------------------+--------+------------------------------+
61-
| ``/gis/ogc/conformance`` | GET | OGC conformance classes |
62-
+-------------------------------------------+--------+------------------------------+
63-
| ``/gis/ogc/collections`` | GET | List feature collections |
64-
+-------------------------------------------+--------+------------------------------+
65-
| ``/gis/ogc/collections/{id}`` | GET | Collection metadata |
66-
+-------------------------------------------+--------+------------------------------+
67-
| ``/gis/ogc/collections/{id}/items`` | GET | Feature items (GeoJSON) |
68-
+-------------------------------------------+--------+------------------------------+
69-
| ``/gis/ogc/collections/{id}/items/{fid}`` | GET | Single feature |
70-
+-------------------------------------------+--------+------------------------------+
71-
| ``/gis/ogc/collections/{id}/qml`` | GET | QGIS style file (extension) |
72-
+-------------------------------------------+--------+------------------------------+
56+
+-------------------------------------------+--------+-----------------------------+
57+
| Endpoint | Method | Description |
58+
+===========================================+========+=============================+
59+
| ``/gis/ogc/`` | GET | OGC API landing page |
60+
+-------------------------------------------+--------+-----------------------------+
61+
| ``/gis/ogc/conformance`` | GET | OGC conformance classes |
62+
+-------------------------------------------+--------+-----------------------------+
63+
| ``/gis/ogc/collections`` | GET | List feature collections |
64+
+-------------------------------------------+--------+-----------------------------+
65+
| ``/gis/ogc/collections/{id}`` | GET | Collection metadata |
66+
+-------------------------------------------+--------+-----------------------------+
67+
| ``/gis/ogc/collections/{id}/items`` | GET | Feature items (GeoJSON) |
68+
+-------------------------------------------+--------+-----------------------------+
69+
| ``/gis/ogc/collections/{id}/items/{fid}`` | GET | Single feature |
70+
+-------------------------------------------+--------+-----------------------------+
71+
| ``/gis/ogc/collections/{id}/qml`` | GET | QGIS style file (extension) |
72+
+-------------------------------------------+--------+-----------------------------+
7373

7474
**Additional endpoints**
7575

‎spp_api_v2_gis/static/description/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -401,9 +401,9 @@ <h1>API Endpoints</h1>
401401
<p><strong>OGC API - Features (primary interface)</strong></p>
402402
<table border="1" class="docutils">
403403
<colgroup>
404-
<col width="53%" />
404+
<col width="54%" />
405405
<col width="10%" />
406-
<col width="37%" />
406+
<col width="36%" />
407407
</colgroup>
408408
<thead valign="bottom">
409409
<tr><th class="head">Endpoint</th>

‎spp_change_request_v2/README.rst‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -752,22 +752,22 @@ Methods available for override on detail models (all inherited from
752752
Related fields available on all detail models (from
753753
``spp.cr.detail.base``):
754754

755-
+----------------------------+-----------+------------------------------------------------------------+
756-
| Field | Type | Source |
757-
+============================+===========+============================================================+
758-
| ``change_request_id`` | Many2one | Direct link to parent CR |
759-
+----------------------------+-----------+------------------------------------------------------------+
760-
| ``registrant_id`` | Many2one | ``change_request_id.registrant_id`` |
761-
+----------------------------+-----------+------------------------------------------------------------+
762-
| ``approval_state`` | Selection | ``change_request_id.approval_state`` |
763-
+----------------------------+-----------+------------------------------------------------------------+
764-
| ``is_applied`` | Boolean | ``change_request_id.is_applied`` |
765-
+----------------------------+-----------+------------------------------------------------------------+
766-
| ``use_dynamic_approval`` | Boolean | ``change_request_id.request_type_id.use_dynamic_approval`` |
767-
+----------------------------+-----------+------------------------------------------------------------+
768-
| ``field_to_modify`` | Selection | Dynamic field selector (populated by |
769-
| | | ``_get_field_to_modify_selection``) |
770-
+----------------------------+-----------+------------------------------------------------------------+
755+
+--------------------------+-----------+------------------------------------------------------------+
756+
| Field | Type | Source |
757+
+==========================+===========+============================================================+
758+
| ``change_request_id`` | Many2one | Direct link to parent CR |
759+
+--------------------------+-----------+------------------------------------------------------------+
760+
| ``registrant_id`` | Many2one | ``change_request_id.registrant_id`` |
761+
+--------------------------+-----------+------------------------------------------------------------+
762+
| ``approval_state`` | Selection | ``change_request_id.approval_state`` |
763+
+--------------------------+-----------+------------------------------------------------------------+
764+
| ``is_applied`` | Boolean | ``change_request_id.is_applied`` |
765+
+--------------------------+-----------+------------------------------------------------------------+
766+
| ``use_dynamic_approval`` | Boolean | ``change_request_id.request_type_id.use_dynamic_approval`` |
767+
+--------------------------+-----------+------------------------------------------------------------+
768+
| ``field_to_modify`` | Selection | Dynamic field selector (populated by |
769+
| | | ``_get_field_to_modify_selection``) |
770+
+--------------------------+-----------+------------------------------------------------------------+
771771

772772
CR Type Fields Reference
773773
~~~~~~~~~~~~~~~~~~~~~~~~

‎spp_change_request_v2/static/description/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1160,9 +1160,9 @@ <h1>Methods Reference</h1>
11601160
<tt class="docutils literal">spp.cr.detail.base</tt>):</p>
11611161
<table border="1" class="docutils">
11621162
<colgroup>
1163-
<col width="28%" />
1163+
<col width="27%" />
11641164
<col width="11%" />
1165-
<col width="61%" />
1165+
<col width="62%" />
11661166
</colgroup>
11671167
<thead valign="bottom">
11681168
<tr><th class="head">Field</th>

‎spp_drims_sl/README.rst‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -61,19 +61,19 @@ Key Configuration Data
6161
Approval Workflow Tiers
6262
~~~~~~~~~~~~~~~~~~~~~~~
6363

64-
+------------------------------+------------------------------+--------+
65-
| Condition | Approvers | SLA |
66-
+==============================+==============================+========+
67-
| Priority = Life-Threatening | Single manager (fast-track) | 0 days |
68-
+------------------------------+------------------------------+--------+
69-
| Value < 100,000 LKR | District approver | 1 day |
70-
+------------------------------+------------------------------+--------+
71-
| Value 100,000 - 500,000 LKR | District → Provincial | 2 days |
72-
| | (2-tier) | |
73-
+------------------------------+------------------------------+--------+
74-
| Value > 500,000 LKR | District → Provincial → | 3 days |
75-
| | National DMC (3-tier) | |
76-
+------------------------------+------------------------------+--------+
64+
+-----------------------------+-------------------------------+--------+
65+
| Condition | Approvers | SLA |
66+
+=============================+===============================+========+
67+
| Priority = Life-Threatening | Single manager (fast-track) | 0 days |
68+
+-----------------------------+-------------------------------+--------+
69+
| Value < 100,000 LKR | District approver | 1 day |
70+
+-----------------------------+-------------------------------+--------+
71+
| Value 100,000 - 500,000 LKR | District → Provincial | 2 days |
72+
| | (2-tier) | |
73+
+-----------------------------+-------------------------------+--------+
74+
| Value > 500,000 LKR | District → Provincial → | 3 days |
75+
| | National DMC (3-tier) | |
76+
+-----------------------------+-------------------------------+--------+
7777

7878
Configuration
7979
~~~~~~~~~~~~~

‎spp_drims_sl/static/description/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,8 +410,8 @@ <h1>Key Configuration Data</h1>
410410
<h1>Approval Workflow Tiers</h1>
411411
<table border="1" class="docutils">
412412
<colgroup>
413-
<col width="44%" />
414-
<col width="44%" />
413+
<col width="43%" />
414+
<col width="46%" />
415415
<col width="12%" />
416416
</colgroup>
417417
<thead valign="bottom">

‎spp_gis_indicators/README.rst‎

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -214,23 +214,21 @@ Preview**.
214214

215215
The **Data Source** tab contains:
216216

217-
+-----------------------------+-----------------------------+----------+
218-
| Field | Description | Required |
219-
+=============================+=============================+==========+
220-
| **Indicator Variable** | Dropdown of | Yes |
221-
| | ``spp.cel.variable`` | |
222-
| | records (no inline | |
223-
| | create/open) | |
224-
+-----------------------------+-----------------------------+----------+
225-
| **Period Key** | Free-text, defaults to | No |
226-
| | "current". Examples: | |
227-
| | "2024-12", "current" | |
228-
+-----------------------------+-----------------------------+----------+
229-
| **Incident/Disaster** | Dropdown of | No |
230-
| | ``spp.hazard.incident`` | |
231-
| | records. Filters indicator | |
232-
| | data by incident. | |
233-
+-----------------------------+-----------------------------+----------+
217+
+------------------------+----------------------------------+----------+
218+
| Field | Description | Required |
219+
+========================+==================================+==========+
220+
| **Indicator Variable** | Dropdown of ``spp.cel.variable`` | Yes |
221+
| | records (no inline create/open) | |
222+
+------------------------+----------------------------------+----------+
223+
| **Period Key** | Free-text, defaults to | No |
224+
| | "current". Examples: "2024-12", | |
225+
| | "current" | |
226+
+------------------------+----------------------------------+----------+
227+
| **Incident/Disaster** | Dropdown of | No |
228+
| | ``spp.hazard.incident`` records. | |
229+
| | Filters indicator data by | |
230+
| | incident. | |
231+
+------------------------+----------------------------------+----------+
234232

235233
Indicator Layer — Form: Visualization Tab
236234
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎spp_gis_indicators/static/description/index.html‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -613,8 +613,8 @@ <h1>Indicator Layer — Form: Data Source Tab</h1>
613613
<p>The <strong>Data Source</strong> tab contains:</p>
614614
<table border="1" class="docutils">
615615
<colgroup>
616-
<col width="43%" />
617-
<col width="43%" />
616+
<col width="35%" />
617+
<col width="50%" />
618618
<col width="15%" />
619619
</colgroup>
620620
<thead valign="bottom">
@@ -625,23 +625,21 @@ <h1>Indicator Layer — Form: Data Source Tab</h1>
625625
</thead>
626626
<tbody valign="top">
627627
<tr><td><strong>Indicator Variable</strong></td>
628-
<td>Dropdown of
629-
<tt class="docutils literal">spp.cel.variable</tt>
630-
records (no inline
631-
create/open)</td>
628+
<td>Dropdown of <tt class="docutils literal">spp.cel.variable</tt>
629+
records (no inline create/open)</td>
632630
<td>Yes</td>
633631
</tr>
634632
<tr><td><strong>Period Key</strong></td>
635633
<td>Free-text, defaults to
636-
“current”. Examples:
637-
“2024-12”, “current”</td>
634+
“current”. Examples: “2024-12”,
635+
“current”</td>
638636
<td>No</td>
639637
</tr>
640638
<tr><td><strong>Incident/Disaster</strong></td>
641639
<td>Dropdown of
642-
<tt class="docutils literal">spp.hazard.incident</tt>
643-
records. Filters indicator
644-
data by incident.</td>
640+
<tt class="docutils literal">spp.hazard.incident</tt> records.
641+
Filters indicator data by
642+
incident.</td>
645643
<td>No</td>
646644
</tr>
647645
</tbody>

‎spp_security/README.rst‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,17 @@ This module defines no model access rights (empty
5959
``ir.model.access.csv``). It provides only security groups and record
6060
rules.
6161

62-
+-----------------------+--------------------------------+----------------------+
63-
| Group | XML ID | Purpose |
64-
+=======================+================================+======================+
65-
| Administrator | ``group_spp_admin`` | Inherits all manager |
66-
| | | permissions from all |
67-
| | | domains |
68-
+-----------------------+--------------------------------+----------------------+
69-
| Restricted: Self Only | ``group_access_restrict_self`` | Restricts users to |
70-
| | | viewing only their |
71-
| | | own record |
72-
+-----------------------+--------------------------------+----------------------+
62+
+----------------------+--------------------------------+----------------------+
63+
| Group | XML ID | Purpose |
64+
+======================+================================+======================+
65+
| Administrator | ``group_spp_admin`` | Inherits all manager |
66+
| | | permissions from all |
67+
| | | domains |
68+
+----------------------+--------------------------------+----------------------+
69+
| Restricted: Self | ``group_access_restrict_self`` | Restricts users to |
70+
| Only | | viewing only their |
71+
| | | own record |
72+
+----------------------+--------------------------------+----------------------+
7373

7474
Record rules:
7575

‎spp_security/static/description/index.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ <h1>Security</h1>
406406
rules.</p>
407407
<table border="1" class="docutils">
408408
<colgroup>
409-
<col width="30%" />
409+
<col width="29%" />
410410
<col width="42%" />
411411
<col width="29%" />
412412
</colgroup>
@@ -423,7 +423,8 @@ <h1>Security</h1>
423423
permissions from all
424424
domains</td>
425425
</tr>
426-
<tr><td>Restricted: Self Only</td>
426+
<tr><td>Restricted: Self
427+
Only</td>
427428
<td><tt class="docutils literal">group_access_restrict_self</tt></td>
428429
<td>Restricts users to
429430
viewing only their

0 commit comments

Comments
 (0)