finishing documentation for mongorest

docs/source/api.rst

@@ -0,0 +1,113 @@
+API
+===
+
+
+
+Collection
+----------
+
+.. autoclass:: mongorest.collection.Collection
+    :members:
+
+
+Decorators
+----------
+
+.. automodule:: mongorest.decorators
+    :members:
+
+
+Middlewares
+-----------
+
+.. automodule:: mongorest.middlewares
+    :members:
+
+
+Resources
+---------
+
+
+Resource
+~~~~~~~~
+
+.. autoclass:: mongorest.resource.Resource
+    :members:
+
+
+ListResourceMixin
+~~~~~~~~~~~~~~~~~
+
+.. autoclass:: mongorest.resource.ListResourceMixin
+    :members:
+
+
+CreateResourceMixin
+~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: mongorest.resource.CreateResourceMixin
+    :members:
+
+
+RetrieveResourceMixin
+~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: mongorest.resource.RetrieveResourceMixin
+    :members:
+
+
+UpdateResourceMixin
+~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: mongorest.resource.UpdateResourceMixin
+    :members:
+
+
+DeleteResourceMixin
+~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: mongorest.resource.DeleteResourceMixin
+    :members:
+
+
+Utils
+-----
+
+.. automodule:: mongorest.utils
+    :members:
+
+
+Wrappers
+--------
+
+
+Request
+~~~~~~~
+
+.. autoclass:: mongorest.wrappers.Request
+    :members:
+
+
+Response
+~~~~~~~~
+
+.. autoclass:: mongorest.wrappers.Response
+    :members:
+
+
+WSGI
+----
+
+
+WSGIWrapper
+~~~~~~~~~~~
+
+.. autoclass:: mongorest.wsgi.WSGIWrapper
+    :members:
+
+
+WSGIDispatcher
+~~~~~~~~~~~~~~
+
+.. autoclass:: mongorest.wsgi.WSGIWrapper
+    :members:

docs/source/conf.py

@@ -36,6 +36,7 @@
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
     'alabaster',
 ]
 

docs/source/index.rst

@@ -13,6 +13,7 @@ Table of Contents
 
     Installation <install>
     Usage <usage>
+    API <api>
     Authors <authors>
     Contact <contact>
     License <license>

mongorest/middlewares.py

@@ -16,6 +16,9 @@
 
 
 class AuthenticationMiddleware(object):
+    """
+    Authentication Middleware works with Cookie and Token Authentication
+    """
 
     def __init__(self, app):
         self.app = app
@@ -84,6 +87,9 @@ def authentication(status, headers, exc_info=None):
 
 
 class CORSMiddleware(object):
+    """
+    CORS Middleware used to overcome CORS restrictions
+    """
 
     def __init__(self, app):
         self.app = app

mongorest/validator.py

@@ -13,6 +13,9 @@
 
 
 class Validator(CerberusValidator):
+    """
+    Class used by the collection to validate documents
+    """
 
     def __init__(self, schema=None, allow_unknown=True, **kwargs):
         super(Validator, self).__init__(

mongorest/wrappers.py

@@ -18,6 +18,9 @@
 
 
 class Request(WerkzeugRequest):
+    """
+    Wrapper around Werkzeug Request object, provides easier access to data
+    """
 
     def __init__(self, environ, populate_request=True, shallow=False):
         super(Request, self).__init__(environ, populate_request, shallow)
@@ -44,6 +47,9 @@ def __init__(self, environ, populate_request=True, shallow=False):
 
 
 class Response(WerkzeugResponse):
+    """
+    Wrapper around Werkzeug Response object, provides easier access to data
+    """
 
     default_mimetype = 'application/json'