Images in module description not properly displayed on app.store and in the list of local modules in an odoo instance.

[lmignon]

The module description is the key element to promote our modules. For modules under OCA, the rule is to put this description in a README.rst file following some specific guidelines. (https://github.com/OCA/maintainer-tools/blob/master/CONTRIBUTING.md#modules)
This file is used by github, odoo and odod.app.store to provide a nicely formatted description of our modules.
When trying to get a nice description of the mis_builder module under all these places I've observed the following problems:

• If you references some images in your description (images stored in static/src/description), even if your file looks fine on github, images are missing in odoo and app.store.
• The licence bagde is not displayed in the app.store

File under github:

Description in Odoo:

Description app.store:

The problem for the images is that the rules to be correctly rendered are not the same depending of the target.

• For github the path to the image must be /static/..../my_img.png
• For Odoo /my_module/static/..../my_img.png
• For app.store my_img.png

For the licence badge, when the file is converted to html5, the image is put directly under the body element and not into a section element. My hypothesis is that the app.store keeps only from the conversion result the 'section' elements (This hypothesis will be verified once OCA/sale-workflow#54 will be merged).

For mis builder, I've solved the problem by manually generating an html description from the REAMDE.rst file. (OCA/account-financial-reporting@6db1e21)
The description is now correctly formatted everywhere.

• 
• https://www.odoo.com/apps/modules/8.0/mis_builder/

This kind of process can be easily automated and launched in the after_success script by travis but is it really the good solution?

[pedrobaeza]

Didn't you find any solution without the HTML?

[dreispt]

AFAIK the appstore was build to work with the module /description subdir.
But the README at the root of the modules needs different paths.
I feel that we should ask Olivier's involvement, and filing an Issue is probably the best way.

[pedrobaeza]

Yeah, we can try that

[lmignon]

@dreispt @pedrobaeza For sure, the problems come from Odoo. I'll fill an issue on Odoo.

[lmignon]

issue on Odoo: odoo/odoo#8300

[moylop260]

USING .. figure:: instead of image is fixed.

[pedrobaeza]

But it's documented on MT template?

[eLBati]

@pedrobaeza I proposed this #204

[pedrobaeza]

Thanks!