Merge pull request #576 from acsone/add-context-sbi

Add a CONTEXT fragment to the readme generator
OCA · Sep 2, 2023 · 4228ec4 · 4228ec4
2 parents 58557dd + 486172e
commit 4228ec4
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/template/module/readme/CONTEXT.rst b/template/module/readme/CONTEXT.rst
@@ -0,0 +1,13 @@
+[ This file is optional but strongly suggested to allow end-users to evaluate the
+module's usefulness in their context. ]
+
+It should explain the “why” of the module:
+
+- in which context or use cases this module can be useful (practical examples are welcome!).
+- what is the business requirement that generated the need to develop this module
+
+It can also inform on related modules:
+
+- modules it depends on and their features
+- other modules that can work well together with this one
+- suggested setups where the module is useful (eg: multicompany, multi-website)
diff --git a/tools/gen_addon_readme.py b/tools/gen_addon_readme.py
@@ -27,6 +27,7 @@
 
 FRAGMENTS = (
     "DESCRIPTION",
+    "CONTEXT",
     "INSTALL",
     "CONFIGURE",
     "USAGE",

diff --git a/tools/gen_addon_readme.rst.jinja b/tools/gen_addon_readme.rst.jinja
@@ -43,7 +43,8 @@
 .. contents::
    :local:
 
-{{ fragment('INSTALL', 'Installation') }}
+{{ fragment('CONTEXT', 'Use Cases / Context') }}
+{{- fragment('INSTALL', 'Installation') }}
 {{- fragment('CONFIGURE', 'Configuration') }}
 {{- fragment('USAGE', 'Usage') }}
 {{- fragment('DEVELOP', 'Development') }}