Paul Johnston wrote: > Hi, > > I've imported tw.dynforms into mercurial and beta.tw.org > <http://beta.tw.org>. I also created > a blank Trac for it in case you want to use it and a quickstarted > sphinx > docs dir with some wiring to hook up with the widgetbrowser and some > dummy sample docs. > > > Ok, it's looking good, although I've not tried a push yet. I'll treat > this as the official tw.dynforms repository as of now, although I > won't remove the twtools.googlecode stuff for now, just in case :-) Scared of the beta prefix? :P > > To generate the docs for preview you don't need the widget browser > installed yet (any widgetbrowser directive will just be ignored and a > warning emitted). easy_install Sphinx and run: > > > Well, it's a start. My main initial wants are: > 1) Only show parameters that belong directly to the widget, not to its > base classes Done. The new WidgetBrowser eggs separates both kinds (inherited and 'local'). Now the GUI needs the ability to hide the inherited ones until the user wants to drill them, working on it... > 2) Pick up documentation in the params dict (perhaps this isn't > possible though; I can always recode) I've opened ticket #4 for it. > 3) Generate doc for all the classes (perhaps everything in __all__, > like apydia) without having to specify them manually
Have you seen Sphinx ... autodoc extension [1]? There's a directive to auto-document a module. The only reason I'm not using it is because I don't like the results (it tries to document every single inherited method of every widget wich are many). One of the things that has sold me to Sphinx is that it you have more control over the documentation process without having to retro-fit the code to play nice with the introspection process (remember __pudge__all__?) Alberto [1] http://sphinx.pocoo.org/ext/autodoc.html --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears Trunk" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/turbogears-trunk?hl=en -~----------~----~----~----~------~----~------~--~---
