Anonymous avatar Anonymous committed e28c929

Document modules.

Comments (0)

Files changed (6)

 
 # General substitutions.
 project = 'WebHelpers'
-copyright = '2009, Mike Orr and Ben Bangert'
+copyright = '2009, Ben Bangert and Mike Orr'
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.

docs/constants.rst

+:mod:`webhelpers.constants`
+================================================
+
+.. automodule:: webhelpers.constants
+
+.. currentmodule:: webhelpers.constants
+
+Countries
+---------
+
+.. autofunction:: country_codes
+
+States & Provinces
+------------------
+
+.. autofunction:: us_states
+.. autofunction:: us_territories
+.. autofunction:: canada_provinces
+.. autofunction:: uk_counties
+
+Deprecations
+------------
+
+The timezone helpers were removed in WebHelpers 0.6.  Install the PyTZ
+package if you need them.

docs/containers.rst

+:mod:`webhelpers.containers`
+================================================
+
+.. automodule:: webhelpers.containers
+
+.. currentmodule:: webhelpers.containers
+
+.. autoclass:: NotGiven
+.. autoclass:: DumbObject
+.. autoclass:: Counter
+.. autoclass:: Accumulator
+.. autoclass:: UniqueAccumulator
+
+.. autofunction:: unique
+.. autofunction:: only_some_keys
+.. autofunction:: except_keys
+.. autofunction:: extract_keys
+.. autofunction:: ordered_items
+.. autofunction:: del_quiet
+.. autofunction:: correlate_dicts
+.. autofunction:: correlate_objects
+.. autofunction:: distribute
+.. autofunction:: transpose
+

docs/contents.rst

-Routes Documentation
-====================
+WebHelpers Documentation
+========================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    
-   manual
+   overview
+   constants
+   containers
 
 .. toctree::
    :maxdepth: 1
    :align: left
 
 .. automodule:: webhelpers
-   :members:
-   :undoc-members:
 
 Module Contents
 ---------------
 
+..
+    <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>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://python.org/pypi/Unidecode/">unidecode</a>, 
+<a href="http://pythonpaste.org/webob/">WebOb</a>
+as noted in their documentation.  The Pylons helpers are designed for <a
+href="http://pylonshq.com/">Pylons</a>' request/response/session objects but
+can easily be ported to another web framework.  WebHelpers comes with an
+extensive set of unit tests.</p>
+
+<p>For support/question/patches, please use the `
+<a href="http://groups.google.com/group/pylons-discuss">Pylons mailing list</a>.</p>
+

docs/overview.rst

+Overview
+===================
+
+.. automodule:: webhelpers
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.