started doc strings for ResQ class and moving along the documentation

Author: yashh

docs/source/class.rst

@@ -0,0 +1,6 @@
+.. module:: pyres
+
+ResQ Classes
+==========================================
+
+.. autoclass:: pyres.ResQ

docs/source/conf.py

@@ -16,7 +16,7 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
+sys.path.append(os.path.abspath(os.path.dirname(__file__+'/../../../')))
 
 # -- General configuration -----------------------------------------------------
 

docs/source/index.rst

@@ -12,6 +12,8 @@ Contents:
    :maxdepth: 2
 
    intro
+   example
+   class
 
 Indices and tables
 ==================

pyres/__init__.py

@@ -41,7 +41,15 @@ def str_to_class(s):
         return None
 
 class ResQ(object):
+    """ResQ class which defines the Queue object to enqueue jobs into various
+    queues.
     
+    Example usage::
+
+        >>> from pyres import *
+        >>> r = ResQ()
+            # Assuming redis is running on default port with no password
+    """
     def __init__(self, server="localhost:6379", password=None, 
                  timeout=None, retry_connection=True):
         self.timeout = timeout