Before I start any documentation effort on Tkinter, I'd like to get a good idea of what's in there right now. Is there a good tool that will go through a module, and print out, in summary form, its functions, classes, methods, etc., with docstrings if present? If not, I'll write my own, but why waste effort if this has already been done? Thanks, Ken
Ken, not sure if this is exactly what you need, but Pydoc is a very simple tool to use. It will generate a series of HTML pages, one for each Python script in your folder tree. All you need to do is place your quoted doc strings as shown in the attached example file. then, to view the documentation, you run pydoc in viewer mode and it launches a browser to show the pages. cheers -- Stewart Midwinter Calgary, Alberta stewart 'at' midwinter 'dot' ca Quoting Kenneth McDonald <kmmcdonald@wisc.edu>:
Before I start any documentation effort on Tkinter, I'd like to get a good idea of what's in there right now. Is there a good tool that will go through a module, and print out, in summary form, its functions, classes, methods, etc., with docstrings if present? If not, I'll write my own, but why waste effort if this has already been done?
Kenneth McDonald wrote:
Before I start any documentation effort on Tkinter, I'd like to get a good idea of what's in there right now. Is there a good tool that will go through a module, and print out, in summary form, its functions, classes, methods, etc., with docstrings if present?
"pythondoc -f -x" generates an XML description of any Python module: http://effbot.org/zone/pythondoc.htm if you know how to manipulate XML files, turning that XML into a stub module should be pretty easy. for bonus points, make your stub generator into a pythondoc output formatter: http://effbot.org/zone/pythondoc-plugins.htm </F>
participants (3)
-
Fredrik Lundh -
Kenneth McDonald -
Stewart Midwinter