new theme and example docs added

Author: yashh

_sources/_theme/ADCTheme/README.txt

@@ -0,0 +1,35 @@
+==============
+How To Install
+==============
+
+Install in Sphinx
+-----------------
+
+Copy this directory into the ``sphinx/templates`` directory where Shpinx is installed. For example, a standard install of sphinx on Mac OS X is at ``/Library/Python/2.6/site-packages/Sphinx-0.6.3-py2.6.egg/``
+
+Install Somewhere Else
+----------------------
+
+If you want to install this theme somewhere else, you will have to modify the ``conf.py`` file. ::
+
+    templates_path = ['/absolute/path/to/dir/','relative/path/']
+
+Making Sphinx Use the Theme
+---------------------------
+
+Edit the ``conf.py`` file and make the following setting: ::
+
+    html_theme = 'ADCtheme'
+
+Screen Shots
+------------
+
+.. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn1.png
+
+.. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn2.png
+
+To Do
+-----
+
+ * Gotta get the javascript working so the Table of Contents is hide-able.
+ * Probably lots of css cleanup.

_sources/_theme/ADCThemePrint/README.txt

@@ -0,0 +1,35 @@
+==============
+How To Install
+==============
+
+Install in Sphinx
+-----------------
+
+Copy this directory into the ``sphinx/templates`` directory where Shpinx is installed. For example, a standard install of sphinx on Mac OS X is at ``/Library/Python/2.6/site-packages/Sphinx-0.6.3-py2.6.egg/``
+
+Install Somewhere Else
+----------------------
+
+If you want to install this theme somewhere else, you will have to modify the ``conf.py`` file. ::
+
+    templates_path = ['/absolute/path/to/dir/','relative/path/']
+
+Making Sphinx Use the Theme
+---------------------------
+
+Edit the ``conf.py`` file and make the following setting: ::
+
+    html_theme = 'ADCtheme'
+
+Screen Shots
+------------
+
+.. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn1.png
+
+.. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn2.png
+
+To Do
+-----
+
+ * Gotta get the javascript working so the Table of Contents is hide-able.
+ * Probably lots of css cleanup.

_sources/example.txt

@@ -1 +1,47 @@
-More coming up
+=========
+ EXAMPLE
+=========
+
+Let's take a real wold example of a blog where comments need to be checked for
+spam check. When the comment is saved in the database, we create a job in the
+queue with comment data. Let's take a django model in this case.::
+
+    class Comment(models.Model):
+        name = Model.CharField()
+        email = Model.EmailField()
+        body = Model.TextField()
+        spam = Model.BooleanField()
+        queue = "Spam"
+    
+        @staticmethod
+        def perform(comment_id):
+            comment = Comment.objects.get(pk=comment_id)
+            params = {"comment_author_email": comment.user.email, 
+                      "comment_content": comment.body,
+                      "comment_author_name": comment.user.name,
+                      "request_ip": comment.author_ip}
+            x = urllib.urlopen("http://apikey.rest.akismet.com/1.1/comment-check", params)
+            if x == "true":
+                comment.spam = True
+            else:
+                comment.spam = False
+            comment.save()
+
+You can convert your existing class to be compatible with Pyres. All you need 
+to do is add a @queue@ variable and define a @perform@ method on the class. 
+
+To insert a job into the queue you need to do something like this:::
+
+    from pyres import ResQ
+    r = Resq()
+    r.enqueue(Spam, 23)   # Passing the comment id 23
+
+This puts a job into the queue **Spam**. Now we need to fire off our workers. 
+In the **scripts** folder there is an executable::
+
+    $ ./pyres_worker Spam
+
+
+Just pass a comma seperated list of queues the worker should poll.
+
+