1.1 --- a/docs/index.html Mon Apr 25 22:03:10 2005 +0000
1.2 +++ b/docs/index.html Mon Apr 25 22:04:02 2005 +0000
1.3 @@ -8,7 +8,7 @@
1.4 </head>
1.5 <body>
1.6 <h1>Creating Web Applications with WebStack</h1>
1.7 -<p>This set of documents describes the process of making a Web
1.8 +<p>This introductory guide describes the process of making a Web
1.9 application
1.10 using the WebStack framework.</p>
1.11 <h2>Setting Up</h2>
1.12 @@ -27,11 +27,25 @@
1.13 sure
1.14 that the <code>WebStack-0.9</code> directory sits on your
1.15 <code>PYTHONPATH</code>.</p>
1.16 +<h2>Generating the API Documentation</h2>
1.17 +<p>In order to view the API documentation in conjunction with this
1.18 +guide, it is necessary to generate some Web pages from the Python
1.19 +source code. For this, the <a href="http://epydoc.sourceforge.net/">epydoc</a>
1.20 +application must be available on your system. Then, change into
1.21 +the <code>WebStack-0.9</code> directory and run the <code>apidocs.sh</code>
1.22 +tool script as follows:</p>
1.23 +<pre>cd WebStack-0.9<br />./tools/apidocs.sh</pre>
1.24 +<p>Some warnings may be generated by the script, but the result should
1.25 +be a new <code>apidocs</code> directory within the <code>WebStack-0.9</code>
1.26 +directory. Of course, it is always possible to view documentation
1.27 +within Python by importing modules (such as <code>WebStack.Generic</code>)
1.28 +and using Python's built-in <code>help</code> function.</p>
1.29 <h2>About WebStack Applications</h2>
1.30 <ul>
1.31 <li><a href="anatomy.html">Anatomy of a WebStack Application</a></li>
1.32 <li><a href="securing.html">Securing a WebStack Application</a></li>
1.33 <li><a href="deploying.html">Deploying a WebStack Application</a></li>
1.34 + <li><a href="integrating.html">Integrating with Other Systems</a></li>
1.35 </ul>
1.36 </body>
1.37 </html>