1.1 --- a/README.txt Mon Apr 25 22:04:02 2005 +0000
1.2 +++ b/README.txt Mon Apr 25 22:19:06 2005 +0000
1.3 @@ -147,12 +147,6 @@
1.4 Session support, especially through WebStack.Helpers.Session, should be
1.5 reviewed and be made compatible with non-cookie mechanisms.
1.6
1.7 -The location of deployed applications in the filesystem should be exposed to
1.8 -those applications.
1.9 -
1.10 -Path information should be consistent across all frameworks, and the "path
1.11 -info" value should be meaningful.
1.12 -
1.13 HeaderValue objects should be employed more extensively. Thus, the header
1.14 access methods may need to change their behaviour slightly.
1.15
1.16 @@ -168,6 +162,15 @@
1.17
1.18 Investigate proper support for HEAD, OPTIONS and other request methods.
1.19
1.20 +(Completed/rejected)
1.21 +
1.22 +The location of deployed applications in the filesystem should be exposed to
1.23 +those applications. (This is actually available in the __file__ module
1.24 +variable.)
1.25 +
1.26 +Path information should be consistent across all frameworks, and the "path
1.27 +info" value should be meaningful. (This should now be correct.)
1.28 +
1.29 Release Procedures
1.30 ------------------
1.31
1.32 @@ -178,4 +181,18 @@
1.33 Check the setup.py file and ensure that all package directories are mentioned.
1.34 Tag, export.
1.35 Generate the PyServlet classes.
1.36 +Generate the API documentation.
1.37 Archive, upload.
1.38 +
1.39 +Generating the API Documentation
1.40 +--------------------------------
1.41 +
1.42 +In order to prepare the API documentation, it is necessary to generate some Web
1.43 +pages from the Python source code. For this, the epydoc application must be
1.44 +available on your system. Then, inside the WebStack directory, run the
1.45 +apidocs.sh tool script as follows:
1.46 +
1.47 +./tools/apidocs.sh
1.48 +
1.49 +Some warnings may be generated by the script, but the result should be a new
1.50 +apidocs directory within the WebStack directory.