# HG changeset patch
# User paulb
# Date 1114467546 0
# Node ID e169b46e46de52c58e810af058e2d92f22644073
# Parent  32f41c83f4ac4a998bcc6d1d294f98146ac3f5d3
[project @ 2005-04-25 22:19:06 by paulb]
Updated the "to do" list. 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 32f41c83f4ac -r e169b46e46de README.txt
--- a/README.txt	Mon Apr 25 22:04:02 2005 +0000
+++ b/README.txt	Mon Apr 25 22:19:06 2005 +0000
@@ -147,12 +147,6 @@
 Session support, especially through WebStack.Helpers.Session, should be
 reviewed and be made compatible with non-cookie mechanisms.
 
-The location of deployed applications in the filesystem should be exposed to
-those applications.
-
-Path information should be consistent across all frameworks, and the "path
-info" value should be meaningful.
-
 HeaderValue objects should be employed more extensively. Thus, the header
 access methods may need to change their behaviour slightly.
 
@@ -168,6 +162,15 @@
 
 Investigate proper support for HEAD, OPTIONS and other request methods.
 
+(Completed/rejected)
+
+The location of deployed applications in the filesystem should be exposed to
+those applications. (This is actually available in the __file__ module
+variable.)
+
+Path information should be consistent across all frameworks, and the "path
+info" value should be meaningful. (This should now be correct.)
+
 Release Procedures
 ------------------
 
@@ -178,4 +181,18 @@
 Check the setup.py file and ensure that all package directories are mentioned.
 Tag, export.
 Generate the PyServlet classes.
+Generate the API documentation.
 Archive, upload.
+
+Generating the API Documentation
+--------------------------------
+
+In order to prepare the API documentation, 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, inside the WebStack directory, run the
+apidocs.sh tool script as follows:
+
+./tools/apidocs.sh
+
+Some warnings may be generated by the script, but the result should be a new
+apidocs directory within the WebStack directory.