From: Markus Gritsch <gritsch@iu...> - 2001-06-02 14:03:41
[from the WebKit User's Guide]
Familiarize yourself with the class docs in order to take advantage of
classes like Page, HTTPRequest, HTTPResponse and Session. Unfortunately, I
couldn't get generated class docs working for this release, so you'll have
to resort to breezing through the source code which is coupled with
documentation strings. Read the examples first.
I wrote a small script which generats the class docs using pydoc (
You can take a look at the generated class docs for Webware 0.5.1-rc3 at
http://in1.iue.tuwien.ac.at/ClassDoc/ and if you like it, I would be glad if
you include pydoc_the_package.py into Webware. pydoc_the_package.py should
be placed into Webware/WebKit/ and startet by the Webware/install.py script.
The WebKit directory has been choosen because when OneShotAdapter.py is
importet, it changed the cwd to this directory anyway. After generating the
class docs, a new directory with the HTML files is created at
The class docs should be generated at install time and not be put statically
to the Webware distribution, because if they are generated, the links to the
sourcefiles at the top-right of the HTML files point to the correct
pydoc.py (and inspect.py) are included in Python 2.1, but to have Webware
not be depend on Python 2.1 it would be possible to include pydoc.py and
inspect.py into Webware/WebKit.
Writing __doc__ strings which consist of only one line without linebreaks is
not very comfortable to read. Maybe this could be changed.
BUGS in Webware 0.5.1-rc3:
*) Webware/DocSupport/ needs an __init__.py file, otherwise "View source of
..." in the examples doesn't work for me on Win98.
*) Webware/PSP/PSPPage.py uses in line 20 spaces instead of tabs (as in the
rest of this file) for indentation, and is therefore not processed correctly
by pydoc. This should be fixed.