Skip to content

Commit 9dd5052

Browse files
committed
[FIX] README template section levels
The README generation could return an error like this: docutils.utils.SystemMessage: account_avatax/README.rst:349: (SEVERE/4) Title level inconsistent: Authors ~~~~~~~ In fact the Authors section is inside a Credits first level title, ``====``, and should be a second level title, ``----``, instead of a third level, ``~~~``.
1 parent c571700 commit 9dd5052

7 files changed

Lines changed: 20 additions & 20 deletions

File tree

tests/data/readme_tests/addon1/README.expected-acme

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,23 +86,23 @@ Credits
8686
=======
8787

8888
Authors
89-
~~~~~~~
89+
-------
9090

9191
* Acme Inc
9292

9393
Contributors
94-
~~~~~~~~~~~~
94+
------------
9595

9696
* contributor1
9797
* contributor2
9898

9999
Other credits
100-
~~~~~~~~~~~~~
100+
-------------
101101

102102
This module has been funded by Acme Corp.
103103

104104
Maintainers
105-
~~~~~~~~~~~
105+
-----------
106106

107107
This module is part of the `acme/server-tools <https://github.com/acme/server-tools/tree/12.0/addon1>`_ project on GitHub.
108108

tests/data/readme_tests/addon1/README.expected-oca

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,23 +92,23 @@ Credits
9292
=======
9393

9494
Authors
95-
~~~~~~~
95+
-------
9696

9797
* Acme Inc
9898

9999
Contributors
100-
~~~~~~~~~~~~
100+
------------
101101

102102
* contributor1
103103
* contributor2
104104

105105
Other credits
106-
~~~~~~~~~~~~~
106+
-------------
107107

108108
This module has been funded by Acme Corp.
109109

110110
Maintainers
111-
~~~~~~~~~~~
111+
-----------
112112

113113
This module is maintained by the OCA.
114114

tests/data/readme_tests/addon_one_maintainer/README.expected-acme

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ Credits
4747
=======
4848

4949
Authors
50-
~~~~~~~
50+
-------
5151

5252
* Acme Inc
5353

5454
Maintainers
55-
~~~~~~~~~~~
55+
-----------
5656

5757
.. |maintainer-toto| image:: https://github.com/toto.png?size=40px
5858
:target: https://github.com/toto

tests/data/readme_tests/addon_one_maintainer/README.expected-oca

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ Credits
5353
=======
5454

5555
Authors
56-
~~~~~~~
56+
-------
5757

5858
* Acme Inc
5959

6060
Maintainers
61-
~~~~~~~~~~~
61+
-----------
6262

6363
This module is maintained by the OCA.
6464

tests/data/readme_tests/addon_two_maintainers/README.expected-acme

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ Credits
4040
=======
4141

4242
Authors
43-
~~~~~~~
43+
-------
4444

4545
* Acme Inc
4646

4747
Maintainers
48-
~~~~~~~~~~~
48+
-----------
4949

5050
.. |maintainer-toto| image:: https://github.com/toto.png?size=40px
5151
:target: https://github.com/toto

tests/data/readme_tests/addon_two_maintainers/README.expected-oca

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ Credits
4646
=======
4747

4848
Authors
49-
~~~~~~~
49+
-------
5050

5151
* Acme Inc
5252

5353
Maintainers
54-
~~~~~~~~~~~
54+
-----------
5555

5656
This module is maintained by the OCA.
5757

tools/gen_addon_readme.template

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,17 @@ Credits
6161

6262
{% if authors -%}
6363
Authors
64-
~~~~~~~
64+
-------
6565

6666
{% for author in authors -%}
6767
* {{ author }}
6868
{% endfor %}
6969
{% endif -%}
7070

71-
{{ fragment('CONTRIBUTORS', 'Contributors', sub='~') }}
72-
{{- fragment('CREDITS', 'Other credits', sub='~') -}}
71+
{{ fragment('CONTRIBUTORS', 'Contributors', sub='-') }}
72+
{{- fragment('CREDITS', 'Other credits', sub='-') -}}
7373
Maintainers
74-
~~~~~~~~~~~
74+
-----------
7575
{%- if org_name == 'OCA' %}
7676

7777
This module is maintained by the OCA.

0 commit comments

Comments
 (0)