1+ on Pudge. I have been using it to document my own projects and been pleased on how it can be used to generate both tutorial and reference documentation.
pro's + Familearity, many of TG's components are already using it (FE, KID, SO, TW) + Uses generic ReST + Easy to use due to buildutils (just run setup.py pudge) + Could be used as the default system to generate compontent + It has a pretty output (we could even make a custom TG theme ;) ) + Suited for smaller projects cons - Unmaintaned* - Doesn't run cleanly on the TG codebase as is** - Not really suited for 'large' projects As you can see I have included the 'suited for smaller projects' argument both as pro and con. Why you might ask? As noted in IRC the TG codebase has grown pretty big. As things stand, pudge might be not be the best solution for the 1.0 reference documentation. Yet TG 2.0 will be all about splitting the current codebase up in to smaller projects. The TG core will probely shrink to a size that can be documented nicely through Pudge. Each component can than have its own (familiar) pudge documentation. Since epydoc also supports ReST markup I would vote for epydoc. TG 0.8 used it too and it worked ok. * The pylons guys have already chosen pudge as there 'prevered' documentation system and it seems they are reviving the project (http://tinyurl.com/vs63g). ** Pudge uses tokenizer.py which sometimes seems to have some trouble with the use of innerclasses. E.g, when running it over the current stable branch its boms out with: "IndentationError: In module turbogears.widgets.datagrid.PaginateDataGrid.attrwrapper.__call__: unindent does not match any outer indentation level" --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears Docs" 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-docs?hl=en -~----------~----~----~----~------~----~------~--~---
