On 8/30/07, Aaron R <[EMAIL PROTECTED]> wrote: > In another message string it was mentioned that James was working on a > replacement for Pudge? Any info on this, i would potentially be > interested in helping as I have a desire for documentation system.
We're very interested in this whole area too, as we have a number of projects with inadequate documentation and want to automate the whole extraction of docs from docstrings plus building HTML docs from text files. I've looked a number of times and haven't found anything resembling a fully functional system for this, and the few that come close look like crap. The best I've seen so far is the hodge-podge of stuff that's in the sqlalchemy project, down in the doc/build folder. As you can tell from the online docs, it's pretty darn good looking, and the tool works fine when run here on the sqlalchemy trunk, which is more than I can say for other packages. (Even pydoc, part of the stdlib, gives errors here, and I have the same troubles with pudge that everyone else seems to have.) Someone suggested pydoctor (http://codespeak.net/~mwh/pydoctor/) recently, but it's got some of the same issues, with its major advantage being that it appears to be under active development which is more than can be said of most packages. A disadvantage though is that at least on first glance it appears to focus solely on docstrings and not on standalone documentation. I'm at the point I probably will start to build something home-grown here, probably trying to model it on the sqlalchemy concepts (but without the ties to Mako and Myghty that seem to be in there), and probably using ReST instead of Markdown or something less "official" in the Python community. Of course, if there really _is_ something out there that others find just works, please please point me to it. (Aaron, you said after the above that you got Pudge working. Does it actually generate the kind of output you want?) -Peter --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "pylons-discuss" 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/pylons-discuss?hl=en -~----------~----~----~----~------~----~------~--~---
