> > 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. >
Thanks for taking this into account, Olivier. > > 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. > I'm don't know rsT in-depth, but all extensions I saw didn't use expressions inline like the ones we need. See this extension for example: http://sphinx.pocoo.org/ext/autosummary.html They use: .. autosummary:: But that must be in a new paragraph which would be useful for screenshots but not for references to menu options or fields. If somebody knows sphinx better than I and knows if directives can be added inside a paragraph I agree it should be the way to go. > > - 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) > It's probably the easiest part. It's 60 lines of code without comments. Maybe you'll need to add the possibility of raising the appropriate tab of a given field, as I had to do in Koo, but that is 11 lines of code, no problem here either. ------------------------ Albert Cervera i Areny http://www.NaN-tic.com OpenERP Partners http://twitter.com/albertnan -------------------- m2f -------------------- -- http://www.openobject.com/forum/viewtopic.php?p=60660#60660 -------------------- m2f -------------------- _______________________________________________ Tinyerp-users mailing list http://tiny.be/mailman2/listinfo/tinyerp-users
