Anonymous avatar Anonymous committed 954dcf9

Documentation home page.

Comments (0)

Files changed (3)

 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
+SPHINXBUILD   = PYTHONPATH=.. sphinx-build
 PAPER         =
 
 # Internal variables.

docs/_templates/index.html

 {% block body %}
 <h1>WebHelpers</h1>
 
-<img src="_images/webhelpers-logo.png" width="100" height="171"
-style="float:left;margin:1em" />
+<img src="_images/webhelpers-logo.png" width="100" height="110" 
+    style="float:left; margin-right:1em" />
+  
+<p>WebHelpers is a collection of utility functions useful in web application
+templates, controller/view code, and non-web applications.  It consists of
+several independent subpackages:</p>
 
-  
-  <p>WebHelpers is package aimed at providing helper functions for use within
-    web applications.</p>
+<br clear="all" />
 
-  <p>These functions are intended to ease web development with template languages by removing common view logic and
-encapsulating it in re-usable modules as well as occasionally providing objects for use within controllers to
-assist with common web development paradigms.</p>
+<table style="border:outset">
+    <tr><th>constants</th><td>Countries &amp; states for address forms
+    </td></tr>
+    <tr><th>containers</th><td>Helpers for collections</td></tr>
+    <tr><th>date</th><td>Date/time helpers</td></tr>
+    <tr><th>feedgenerator</th><td>Create RSS or Atom feeds</td></tr>
+    <tr><th>html</th><td>HTML tags and form tags</td></tr>
+    <tr><th>markdown/textile</th><td>Convert
+    wiki-like text to HTML</td></tr>
+    <tr><th>media</th><td>Image files</td></tr>
+    <tr><th>mimehelper</th><td>MIME types</td></tr>
+    <tr><th>misc/util</th><td>Other helpers</td></tr>
+    <tr><th>number</th><td>Formatters and statistics</td></tr>
+    <tr><th>paginate</th><td>Display records a pageful at a time
+    </td></tr>
+    <tr><th>pylonslib</th><td>Helpers for Pylons</td></tr>
+    <tr><th>text</th><td>Text processing</td></tr>
+</table>
 
-  <p>For support/question/patches, please use the `Pylons mailing list
-  <http://groups.google.com/group/pylons-discuss>`_.</p>
+<p>WebHelpers is pure Python and has no dependencies.  However, a few
+helpers depend on 
+<a href="http://routes.groovie.org/">Routes</a>, 
+<a href="http://pylonshq.com/">Pylons</a>, 
+<a href="http://python.org/pypi/Unidecode/">unidecode</a>, 
+<a href="http://pythonpaste.org/webob/">WebOb</a>
+as noted in their documentation.  WebHelpers comes with an extensive set of
+unit tests.</p>
 
-  <p>*Requirements:* Some WebHelper functions require `Routes <http://routes.groovie.org/>`_ to be active in the
-framework for a variety of functions. Currently `Pylons <http://pylons.groovie.org/>`_, `TurboGears <http://trac.turbogears.org/turbogears/wiki/RoutesIntegration>`_,
-and `Aquarium <http://aquarium.sourceforge.net/>`_ support Routes.</p>
-
-  <p>Buzzword Compliance: <em>...</em>, <em>...</em></p>
-
-  <br clear="all" />
+<p>For support/question/patches, please use the `
+<a href="http://groups.google.com/group/pylons-discuss">Pylons mailing list</a>.</p>
 
 <h2>New features</h2>
 
 <div style="font-size:smaller">
 
-<p>Version 1.0b1 (YYYY-MM-DD)</p>
+<p>Version 1.0b1 (YYYY-MM-DD -- not released yet)</p>
 
 <ul>
-    <li>Completely new manual</li>
-    <li></li>
+    <li>Documentation rewrite.</li>
+    <li>Many new helpers in <code>html.converters</code>,
+    <code>html.tags</code>, <code>html.tools</code>, <code>paginate</code>,
+    <code>pylonslib</code>, <code>text</code>.</li>
+    <li>Delete deprecated subpackages: <code>commands</code>,
+    <code>hinclude</code>, <code>htmlgen</code>, <code>pagination</code>,
+    <code>rails</code>. <strong>CAUTION:</strong> if using these helpers, stick
+    to WebHelpers 0.6.4.</li>
 </ul>
 
+<p>Version 0.6.4 (2008-12-02)
+
+<ul>
+    <li>Several form helpers have magic ID attribute.</li>
+    <li>Bugfixes in <code>ModelTags.select</code>.</li>
+</ul>
 
 </div>
 
     </td></tr>
   </table>
   
-  <p>Download <a href="http://webhelpers.groovie.org/webhelpers.pdf">webhelpers PDF documentation</a>.</p>
+  <p>Download <a href="http://webhelpers.groovie.org/webhelpers.pdf">WebHelpers PDF documentation</a>.</p>
 
   <h2>Developers / Source Code</h2>
   <p>WebHelpers' Mercurial repository can be found at
 :mod:`webhelpers` -- WebHelpers module 
 ================================================
 
+.. image:: webhelpers-logo.png
+   :width: 100
+   :height: 110
+   :align: left
+
 .. automodule:: webhelpers
+   :members:
+   :undoc-members:
 
 Module Contents
 ---------------
 
- ..
-
-    .. currentmodule:: webhelpers
-
-
-    .. autofunction:: request_config
-
-    .. autoclass:: Mapper
-        :members: connect, create_regs, generate, match, redirect, resource, routematch
-
-    .. autoclass:: URLGenerator
-
-    .. autofunction:: url_for
-
-    .. autofunction:: redirect_to
-
-    .. currentmodule:: routes.mapper
-    .. autofunction:: strip_slashes
-
-    .. currentmodule:: routes.middleware
-
-    .. autoclass:: RoutesMiddleware
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.