On Jun 27, 2007, at 8:43 PM, Mark Ramm wrote:

> I think we should use pudge for API doc generation, and I want to be
> fairly hard-core about getting good docstrings, comments and an API
> overview together so new developers can jump into TG2 development
> quickly.
>
> My reasoning for picking Pudge is simple -- it's what's used in
> pylons, paste, and other sub-projects.

I think it's worth to investigate something else... I've been using  
Pudge for ToscaWidgets' API docs and I think you can blame it for the  
current state of TW's docs :P.... Now seriously, I personally don't  
like it... but it's been too long since I don't use it to give  
compelling reasons... one thing I do remember is that it was *slow*.

I think that an API generator that supported rST output (not only  
input in the docstrings) would be great since it would allow us to  
script it to push the API  docs to docs.turbogears.org and  
docs.pythonweb.org. Does something like this exist?

Alberto

--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---

Reply via email to