I'm definitely not the expert here, but it looks like the current version of pythondoc allows you to use docstrings as well as comments.
But, I think that having some kind of API docs (any kind at all really) is better than nothing, so if you're willing to help make this happen with epydoc that's the way we should go ;) We really need API documentation as soon as possible ;) --Mark Ramm On 1/7/07, Jorge Vargas <[EMAIL PROTECTED]> wrote:
On 1/7/07, Mark Ramm <[EMAIL PROTECTED]> wrote: > > Is anybody working on this? I remember that Kevin had a plan for > this, but I don't think it ever saw the light of day. > yes Indeed I was worried about this a while ago I send a couple of emails to kevin and it ended up in well nothing :) basically I set out to check for the tools out there. as you can see from the transcript below I wanted to go with epydoc and kevin wanted pythondoc and we just agree to disagree on that one. I still think we should go with epydoc it's more pythonic and well to this day noone has used the javadoc style comments. by the way the URL is no longer valid if you want I can upload it again. here is a copy of our emails. ------------------ On 10/23/06, Kevin Dangoor <[EMAIL PROTECTED]> wrote: > Hi, > > take a look at the apigen stuff in the turbogears source... I moved > from epydoc to pythondoc because it was source based and quite > flexible... source based? well epydoc takes everything from the docstrings > many people weren't keen on the javadoc style of epydoc. > yes indeed since I don't see any javadoc type comments. can we go back to epydoc? I really like it and we really need to publish an API - Hide quoted text - > Kevin > > On Oct 16, 2006, at 2:02 AM, Jorge Vargas wrote: > > > hi > > > > I find this kind of in the middle of nowhere. > > > > I google around and found 3 package > > pydoc (stdlib) > > pythondoc (the one we are "using") > > epydoc > > > > I believe we should go to epydoc (because it isn't as ugly as pydoc, > > and I went into it's source and the colors are hardcoded, so it will > > have to be patch) > > > > I find epydoc very pleasent to navigate and some of it's feature will > > be good for us. > > Also since they have CSS unlike pydoc, we can get the TG look into > > the docs. > > > > the problem I see with pythondoc is that it depends on this seudo > > javadoc syntax and it will take us ages to get all that up. > > > > I have uploaded a temp copy of the api generated by epydoc to > > http://mae.webfactional.com/turbogears/docs/ > > > > for you to take a look > > > -- > Kevin Dangoor > TurboGears / Zesty News > > email: [EMAIL PROTECTED] > company: http://www.BlazingThings.com > blog: http://www.BlueSkyOnMars.com > > > > >
-- Mark Ramm-Christensen email: mark at compoundthinking dot com blog: www.compoundthinking.com/blog --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
