# HG changeset patch # User paulb # Date 1114467560 0 # Node ID 7b0c3aae7b35bede26993b72909a022a54609180 # Parent e169b46e46de52c58e810af058e2d92f22644073 [project @ 2005-04-25 22:19:20 by paulb] Moved information about generating the API documentation out of the introductory guide and into the README.txt file, since releases will have pre-built API documentation. diff -r e169b46e46de -r 7b0c3aae7b35 docs/index.html --- a/docs/index.html Mon Apr 25 22:19:06 2005 +0000 +++ b/docs/index.html Mon Apr 25 22:19:20 2005 +0000 @@ -27,18 +27,13 @@ sure that the WebStack-0.9 directory sits on your PYTHONPATH.

-

Generating the API Documentation

-

In order to view the API documentation in conjunction with this -guide, it is necessary to generate some Web pages from the Python -source code. For this, the epydoc -application must be available on your system. Then, change into -the WebStack-0.9 directory and run the apidocs.sh -tool script as follows:

-
cd WebStack-0.9
./tools/apidocs.sh
-

Some warnings may be generated by the script, but the result should -be a new apidocs directory within the WebStack-0.9 -directory. Of course, it is always possible to view documentation -within Python by importing modules (such as WebStack.Generic) +

Viewing the API Documentation

+

The API documentation for use in conjunction with this +guide can be found inside the apidocs +directory within the WebStack-0.9 directory. Of course, +it is always possible to view WebStack's API documentation +within Python by importing modules (such as WebStack.Generic) and using Python's built-in help function.

About WebStack Applications