← Back to team overview

openerp-community team mailing list archive

Re: About description and manual files for OCAmodules

 

On 03/04/2014 07:50 PM, Raphael Valyi wrote:
> On Tue, Mar 4, 2014 at 2:38 PM, Pedro Manuel Baeza Romero
> <pedro.baeza@xxxxxxxxx <mailto:pedro.baeza@xxxxxxxxx>> wrote:
>
> Hi, Raphäel,
>
>
> In this MP, Stefan has embedded an image in the description:
>
>
http://bazaar.launchpad.net/~therp-nl/account-financial-tools/7.0-add_move_line_no_default_search_period_journal/view/head:/account_move_line_no_default_search/__openerp__.py#L35
>
>
>
So, there's a way to do it.
> 
>
> Thank your Pedro! I was probably using the wrong path before.
>
> Then I make the following proposal:
>
> a module could have README.rst root file. This README..rst file could
> then be included into __openerp__.py using an rst include macro such
> as with the image example you just pointed.
>

Unfortunately, docutils does not support the specifications of include
paths yet (proof of concept here:
http://comments.gmane.org/gmane.text.docutils.devel/6605), so this would
not work unless the rst was preprocessed by OpenERP. The fact that
images work in the web client modules view is due to the fact that
docutils simply creates an absolute link, which is available in the web
client if you put the image in the static directory. I now realize that
this is not going to work in the apps site, because the static path is
not available there and the absolute path has a different prefix anyway.

Cheers,
Stefan.


Follow ups

References