summaryrefslogtreecommitdiff
path: root/openerp/modules/module.py
diff options
context:
space:
mode:
authorDaniel Reis <dgreis@sapo.pt>2014-08-13 09:57:53 +0100
committerOlivier Dony <odo@openerp.com>2014-09-12 18:31:32 +0200
commitec0b770ed3c4f4fbdf0f24930aaa05bcc5cb0b53 (patch)
tree1b610f271d122ba80af39a9bb37020330d8d8860 /openerp/modules/module.py
parente049e56b3ffe43384bd9a0cac2a425e59911f96f (diff)
[IMP] modules: add support for loading module description from README.{md,rst,txt}
Showcase the feature by moving auth_ldap's description to README.rst (Manual rebase of PR #1759)
Diffstat (limited to 'openerp/modules/module.py')
-rw-r--r--openerp/modules/module.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/openerp/modules/module.py b/openerp/modules/module.py
index 368ee43beb8..b9a77f5f7f3 100644
--- a/openerp/modules/module.py
+++ b/openerp/modules/module.py
@@ -39,6 +39,7 @@ import openerp.release as release
from openerp.tools.safe_eval import safe_eval as eval
MANIFEST = '__openerp__.py'
+README = ['README.rst', 'README.md', 'README.txt']
_logger = logging.getLogger(__name__)
@@ -248,6 +249,13 @@ def load_information_from_description_file(module, mod_path=None):
finally:
f.close()
+ if not info.get('description'):
+ readme_path = [opj(mod_path, x) for x in README
+ if os.path.isfile(opj(mod_path, x))]
+ if readme_path:
+ readme_text = tools.file_open(readme_path[0]).read()
+ info['description'] = readme_text
+
if 'active' in info:
# 'active' has been renamed 'auto_install'
info['auto_install'] = info['active']