forked from Tecnativa/doodba-copier-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.module-readme.rst.j2
87 lines (66 loc) · 2.73 KB
/
.module-readme.rst.j2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{%- macro fragment(name, title, sub='=') %}
{%- if name in fragments %}
{{- title }}
{{ sub * title|length }}
{{ fragments[name] }}
{% endif %}
{%- endmacro -%}
{{ '=' * manifest.name|length }}
{{ manifest.name }}
{{ '=' * manifest.name|length }}
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: {{ source_digest }}
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge_devstat| image:: https://img.shields.io/badge/maturity-{{ development_status | replace("-", "--") | urlencode }}-brightgreen.png
:target: https://odoo-community.org/page/development-status
:alt: {{ development_status | title }}
.. |badge_license| image:: https://img.shields.io/badge/license-{{ manifest.license | d("Unknown") | replace("-", "--") | urlencode }}-blue.png
:alt: {{ manifest.license | d("Unknown") }}
|badge_devstat| |badge_license|
{{ fragments.get('DESCRIPTION', '') }}
{% if development_status == 'alpha' -%}
.. IMPORTANT::
This is an alpha version, the data model and design can change at any time without warning.
Only for development or testing purpose, do not use in production.
`More details on development status <https://odoo-community.org/page/development-status>`_
{% endif -%}
**Table of contents**
.. contents::
:local:
{{ fragment('CONTEXT', 'Use Cases / Context') }}
{{- fragment('INSTALL', 'Installation') }}
{{- fragment('CONFIGURE', 'Configuration') }}
{{- fragment('USAGE', 'Usage') }}
{{- fragment('DEVELOP', 'Development') }}
{{- fragment('ROADMAP', 'Known issues / Roadmap') -}}
{{- fragment('HISTORY', 'Changelog') -}}
Credits
{#- HACK Avoid conflicts with pre-commit's check-merge-conflict #}
{{ "=======" }}
{% if authors -%}
Authors
{{ level3_underline * 7 }}
{% for author in authors if author -%}
* {{ author }}
{% endfor %}
{% endif -%}
{{ fragment('CONTRIBUTORS', 'Contributors', sub=level3_underline) }}
{{- fragment('CREDITS', 'Other credits', sub=level3_underline) -}}
Maintainers
{{ level3_underline * 11 }}
This module is maintained by {{ org_name }}.
Contact the maintainer through their official support channels in case you find
any issues with this module.
{% if manifest.maintainers %}
{% for maintainer in manifest.maintainers %}
.. |maintainer-{{ maintainer }}| image:: https://github.com/{{ maintainer }}.png?size=40px
:target: https://github.com/{{ maintainer }}
:alt: {{ maintainer}}
{%- endfor %}
Current maintainer{% if manifest.maintainers|length > 1 %}s{% endif %}:
{% for maintainer in manifest.maintainers %}|maintainer-{{ maintainer }}|{% if not loop.last %} {% endif %}{% endfor %}
{% endif %}