Tuesday 1 March 2011

Contribution to Documentation

Hello All,

We very much appreciate your input and your help to improve the OpenERP documentation.

Still we would like to ask you to strictly follow the guidelines. We often have problems building the documentation, because lines are too short, bullet lists end without a blank line, ...

These might seem details, but when building the documentation, all of this (and more) is checked.

Before pushing changes, please build the documentation yourself (make clean / make html) to see that no errors occur. In case you get errors, please correct them before pushing.


Thanks for your help! We very much appreciate your effort!

Regards,

Els

1 comment:

  1. Worth noting is that you need to have Sphinx installed, in Ubuntu it's as easy as 'apt-get install python-sphinx' for other platforms take a look at http://sphinx.pocoo.org/

    ReplyDelete