> We have just made a post explaining the new documentation infrastructure we > have created. We hope this will become the official documentation system for > openerp, so you can take a look at it here: > > http://ves.cat/ai6P > > Comments, ideas and concerns are very welcomed.
Hello Albert, This is most interesting, I remember we discussed this feature a while ago during the community days. Very impressive work there!! Your post about the rationale for introducing this is very nice to read too :-) I like a lot the fact that you implemented as much you could in an OpenERP addon, and that you used Sphinx and RST to implement a developer-friendly framework, without forgetting the other stakeholders like end-users and translators in the balance. The fact that the documentation allows inheritance and replacements is very very cool too! Basically I think we should indeed consider using this as the default module documentation framework, and I will initiate an internal discussion about this at OpenERP. In order to do so, I have a few naive questions that come to mind (more will probably follow later): - Is there a particular reason you did not use the regular Sphinx extension mechanism (http://sphinx.pocoo.org/extensions.html) to implement your identifiers and replacements? I think this would improve quite elegantly the compatibility and extensibility of the documentation written with this framework, wouldn't it? Developers familiar with Sphinx would be at home directly as well. - The screenshot generation system is a key feature, so I am wondering: do you have some documentation on how you implemented this for Koo, and how much time it took? (I'm not a great GTK developer so I don't really have an idea) Thanks a lot for your answers and kudos for the great work! ------------------------ Olivier Dony OpenERP s.a. -------------------- m2f -------------------- -- http://www.openobject.com/forum/viewtopic.php?p=60653#60653 -------------------- m2f -------------------- _______________________________________________ Tinyerp-users mailing list http://tiny.be/mailman2/listinfo/tinyerp-users
