Skip to content

Commit 733c081

Browse files
emjay0921emjay0921
committed
chore(spp_gis_indicators): replace markdown tables with lists in DESCRIPTION
Markdown tables in DESCRIPTION.md cause RST column width differences between local and CI versions of oca-gen-addon-readme. Using bullet lists avoids the issue entirely.
1 parent 3bea5e3 commit 733c081

3 files changed

Lines changed: 28 additions & 78 deletions

File tree

‎spp_gis_indicators/README.rst‎

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,12 @@ Key Capabilities
4646
Key Models
4747
~~~~~~~~~~
4848

49-
+-----------------------------+---------------------------------------+
50-
| Model | Description |
51-
+=============================+=======================================+
52-
| ``spp.gis.indicator.layer`` | Configuration linking a CEL variable |
53-
| | to color scale and classification |
54-
| | settings |
55-
+-----------------------------+---------------------------------------+
56-
| ``spp.gis.color.scale`` | Color scheme definition with JSON |
57-
| | array of hex colors |
58-
+-----------------------------+---------------------------------------+
59-
| ``spp.gis.data.layer`` | Extended with ``choropleth`` geo |
60-
| | representation option |
61-
+-----------------------------+---------------------------------------+
49+
- **spp.gis.indicator.layer** -- Configuration linking a CEL variable to
50+
color scale and classification settings
51+
- **spp.gis.color.scale** -- Color scheme definition with JSON array of
52+
hex colors
53+
- **spp.gis.data.layer** -- Extended with choropleth geo representation
54+
option
6255

6356
Configuration
6457
~~~~~~~~~~~~~
@@ -83,13 +76,9 @@ UI Location
8376
Security
8477
~~~~~~~~
8578

86-
================================== =============================
87-
Group Access
88-
================================== =============================
89-
``spp_security.group_spp_user`` Read
90-
``spp_security.group_spp_manager`` Read/write/create (no delete)
91-
``spp_security.group_spp_admin`` Full CRUD
92-
================================== =============================
79+
- **spp_security.group_spp_user** -- Read
80+
- **spp_security.group_spp_manager** -- Read/write/create (no delete)
81+
- **spp_security.group_spp_admin** -- Full CRUD
9382

9483
Extension Points
9584
~~~~~~~~~~~~~~~~

‎spp_gis_indicators/readme/DESCRIPTION.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,9 @@ Choropleth visualization for area-level indicators on GIS maps. Maps indicator v
1212

1313
### Key Models
1414

15-
| Model | Description |
16-
| -------------------------- | ------------------------------------------------------------------------------- |
17-
| `spp.gis.indicator.layer` | Configuration linking a CEL variable to color scale and classification settings |
18-
| `spp.gis.color.scale` | Color scheme definition with JSON array of hex colors |
19-
| `spp.gis.data.layer` | Extended with `choropleth` geo representation option |
15+
- **spp.gis.indicator.layer** -- Configuration linking a CEL variable to color scale and classification settings
16+
- **spp.gis.color.scale** -- Color scheme definition with JSON array of hex colors
17+
- **spp.gis.data.layer** -- Extended with choropleth geo representation option
2018

2119
### Configuration
2220

@@ -35,11 +33,9 @@ After installing:
3533

3634
### Security
3735

38-
| Group | Access |
39-
| -------------------------------- | ----------------------------- |
40-
| `spp_security.group_spp_user` | Read |
41-
| `spp_security.group_spp_manager` | Read/write/create (no delete) |
42-
| `spp_security.group_spp_admin` | Full CRUD |
36+
- **spp_security.group_spp_user** -- Read
37+
- **spp_security.group_spp_manager** -- Read/write/create (no delete)
38+
- **spp_security.group_spp_admin** -- Full CRUD
4339

4440
### Extension Points
4541

‎spp_gis_indicators/static/description/index.html‎

Lines changed: 13 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -393,32 +393,14 @@ <h1>Key Capabilities</h1>
393393
</div>
394394
<div class="section" id="key-models">
395395
<h1>Key Models</h1>
396-
<table border="1" class="docutils">
397-
<colgroup>
398-
<col width="43%" />
399-
<col width="57%" />
400-
</colgroup>
401-
<thead valign="bottom">
402-
<tr><th class="head">Model</th>
403-
<th class="head">Description</th>
404-
</tr>
405-
</thead>
406-
<tbody valign="top">
407-
<tr><td><tt class="docutils literal">spp.gis.indicator.layer</tt></td>
408-
<td>Configuration linking a CEL variable
409-
to color scale and classification
410-
settings</td>
411-
</tr>
412-
<tr><td><tt class="docutils literal">spp.gis.color.scale</tt></td>
413-
<td>Color scheme definition with JSON
414-
array of hex colors</td>
415-
</tr>
416-
<tr><td><tt class="docutils literal">spp.gis.data.layer</tt></td>
417-
<td>Extended with <tt class="docutils literal">choropleth</tt> geo
418-
representation option</td>
419-
</tr>
420-
</tbody>
421-
</table>
396+
<ul class="simple">
397+
<li><strong>spp.gis.indicator.layer</strong> – Configuration linking a CEL variable to
398+
color scale and classification settings</li>
399+
<li><strong>spp.gis.color.scale</strong> – Color scheme definition with JSON array of
400+
hex colors</li>
401+
<li><strong>spp.gis.data.layer</strong> – Extended with choropleth geo representation
402+
option</li>
403+
</ul>
422404
</div>
423405
<div class="section" id="configuration">
424406
<h1>Configuration</h1>
@@ -443,28 +425,11 @@ <h1>UI Location</h1>
443425
</div>
444426
<div class="section" id="security">
445427
<h1>Security</h1>
446-
<table border="1" class="docutils">
447-
<colgroup>
448-
<col width="54%" />
449-
<col width="46%" />
450-
</colgroup>
451-
<thead valign="bottom">
452-
<tr><th class="head">Group</th>
453-
<th class="head">Access</th>
454-
</tr>
455-
</thead>
456-
<tbody valign="top">
457-
<tr><td><tt class="docutils literal">spp_security.group_spp_user</tt></td>
458-
<td>Read</td>
459-
</tr>
460-
<tr><td><tt class="docutils literal">spp_security.group_spp_manager</tt></td>
461-
<td>Read/write/create (no delete)</td>
462-
</tr>
463-
<tr><td><tt class="docutils literal">spp_security.group_spp_admin</tt></td>
464-
<td>Full CRUD</td>
465-
</tr>
466-
</tbody>
467-
</table>
428+
<ul class="simple">
429+
<li><strong>spp_security.group_spp_user</strong> – Read</li>
430+
<li><strong>spp_security.group_spp_manager</strong> – Read/write/create (no delete)</li>
431+
<li><strong>spp_security.group_spp_admin</strong> – Full CRUD</li>
432+
</ul>
468433
</div>
469434
<div class="section" id="extension-points">
470435
<h1>Extension Points</h1>

0 commit comments

Comments
 (0)