On Mon, Dec 15, 2008 at 5:07 PM, Iain Duncan <[email protected]> wrote: > > Hi folks, I'm working on a wsgi app that I hope to eventually make > public. I'm not sure what to do about documentation, I plan on using > Sphinx for hand written docs, but don't know whether I should also use a > javadoc style tool like epydoc or doxygen, and if so, which one. If > folks could tell me what seems to be the preferrence for TG related > projects that would be great. > My personal opinion is that sphinx is the way to go, javadoc type tools tend to make the codebase a lot bigger and something are just bloat, with sphinx you can take care of documenting api, even reading docstrings, but I believe proper docs should be their own thing (ie sphinx), then have docstring for only the very important things. And of course avoid the typical "autogenerated" docs of javadoc-like tools, in the forms @param a : a is a String and that type of stuff.
--~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears" 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?hl=en -~----------~----~----~----~------~----~------~--~---
