Odoo Help


This community is for beginners and experts willing to share their Odoo knowledge. It's not a forum to discuss ideas, but a knowledge base of questions and their answers.


What's the best way to write documentation for my module and give it visibility ?

Antonin Bourguignon (abo)
on 1/31/13, 7:30 AM 1,382 views

Where should I put the technical documentation ? And the functional ? In which format (RST, HTML, ...) ?

Vo Minh Thu
On 2/5/13, 9:05 AM

Since version 7.0, the official technical documentation for each module is in its doc/ directory in the RST format. For instance, the web and mail addons have such a doc/ directory. The doc/ directory for the framework is at the root of its source tree (i.e. alongside of the openerp/ directory).

To write new documentation for a module that do not have such a doc/ directory, the best thing to do is to mimic what is done in web and mail.

The official documentation is built automatically on doc.openerp.com. (There is no specific documentation for 7.0. Instead doc.openerp.com/trunk applies.)

For unofficial modules the same convention can be used but a service such as readthedocs.org would be used to publish it automatically.

Alan Bell
On 2/5/13, 8:00 AM

if you put information in RST format in the description field (about a pagefull) then this turns up on the module page when you go to install it.

Ok, that's more a module description, not actual documentation ;)

Antonin Bourguignon (abo)
on 2/5/13, 8:58 AM
Imre Van den berge
On 3/31/14, 11:10 AM

Hi Anto! I leave it up to you to decide whether this'll be 'the best' way to write documentation for your custom-built OpenERP module and give it some visibility... However do know that we recently launched our website 'OERPtuts', where we'd like to post the exact same information as you described in your question.

Please feel free to contact us through our contact form at www.oerptuts.com/contact/ if you should be interested to receive some brand awareness for your custom-built OpenERP module. At the time of writing OERPtuts is still brand new, however you'll already find some extra information in our first launch post at www.oerptuts.com/articles/news/launch-time/. At our website, you can also subscribe to the OERPtuts Newsletter to receive automatic updates of future posts...

Your Answer

Please try to give a substantial answer. If you wanted to comment on the question or answer, just use the commenting tool. Please remember that you can always revise your answers - no need to answer the same question twice. Also, please don't forget to vote - it really helps to select the best questions and answers!

About This Community

This community is for professionals and enthusiasts of our products and services. Read Guidelines

Question tools

3 follower(s)


Asked: 1/31/13, 7:30 AM
Seen: 1382 times
Last updated: 3/16/15, 8:10 AM