docs: updates

ergo · Jul 16, 2015 · aec438f · aec438f
1 parent f6873c3
commit aec438f
Show file tree

Hide file tree

Showing 7 changed files with 136 additions and 105 deletions.
diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,19 @@
+=================
+API Documentation
+=================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 1
+
+   models
+   services
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/api/models.rst b/docs/api/models.rst
@@ -0,0 +1,45 @@
+=================
+Models
+=================
+
+
+.. autoclass:: ziggurat_foundations.models.user.UserMixin
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.external_identity.ExternalIdentityMixin
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.group.GroupMixin
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.group_permission.GroupPermissionMixin
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.user_permission.UserPermissionMixin
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.user_group.UserGroupMixin
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.group_resource_permission.GroupResourcePermissionMixin
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.user_resource_permission.UserResourcePermissionMixin
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.resource.ResourceMixin
+    :members:
+
+.. autofunction:: ziggurat_foundations.models.base.get_db_session
+
+
+.. autoclass:: ziggurat_foundations.models.base.BaseModel
+    :members:
diff --git a/docs/api/services.rst b/docs/api/services.rst
@@ -0,0 +1,36 @@
+=================
+Services
+=================
+
+
+.. autoclass:: ziggurat_foundations.models.services.user.UserService
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.services.external_identity.ExternalIdentityService
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.services.group.GroupService
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.services.group_permission.GroupPermissionService
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.services.user_permission.UserPermissionService
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.services.user_group.UserGroupService
+    :members:
+
+
+
+.. autoclass:: ziggurat_foundations.models.services.user_resource_permission.UserResourcePermissionService
+    :members:
+
+
+.. autoclass:: ziggurat_foundations.models.services.resource.ResourceService
+    :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -33,9 +33,11 @@ Contents:
    overview
    tutorial
    extensions/pyramid
-   api
+   api/index
+
    changelog
 
+
 .. note::
 
     By default ziggurat aims at **postgresql 8.4+** (CTE support) as main RDBMS system,

diff --git a/ziggurat_foundations/models/external_identity.py b/ziggurat_foundations/models/external_identity.py
@@ -47,6 +47,15 @@ def token_secret(self):
     @classmethod
     def by_external_id_and_provider(cls, external_id, provider_name,
                                     db_session=None):
+        """
+        Backwards compatible alias to
+        :class:`ziggurat_foundations.models.services.external_identity.ExternalIdentityService.by_external_id_and_provider`
+
+        :param external_id:
+        :param provider_name:
+        :param db_session:
+        :return: ExternalIdentity
+        """
         db_session = get_db_session(db_session)
         return ExternalIdentityService.by_external_id_and_provider(
             external_id=external_id, provider_name=provider_name,
@@ -55,6 +64,15 @@ def by_external_id_and_provider(cls, external_id, provider_name,
     @classmethod
     def user_by_external_id_and_provider(cls, external_id, provider_name,
                                          db_session=None):
+        """
+        Backwards compatible alias to
+        :class:`ziggurat_foundations.models.services.external_identity.ExternalIdentityService.user_by_external_id_and_provider`
+
+        :param external_id:
+        :param provider_name:
+        :param db_session:
+        :return: User
+        """
         db_session = get_db_session(db_session)
         return ExternalIdentityService.user_by_external_id_and_provider(
             external_id=external_id, provider_name=provider_name,

diff --git a/ziggurat_foundations/models/services/external_identity.py b/ziggurat_foundations/models/services/external_identity.py
@@ -7,6 +7,14 @@ class ExternalIdentityService(BaseService):
     @classmethod
     def by_external_id_and_provider(cls, external_id, provider_name,
                                     db_session=None):
+        """
+        Returns ExternalIdentity instance based on search params
+
+        :param external_id:
+        :param provider_name:
+        :param db_session:
+        :return: ExternalIdentity
+        """
         db_session = get_db_session(db_session)
         query = db_session.query(cls.model)
         query = query.filter(cls.model.external_id == external_id)
@@ -16,6 +24,13 @@ def by_external_id_and_provider(cls, external_id, provider_name,
     @classmethod
     def user_by_external_id_and_provider(cls, external_id, provider_name,
                                          db_session=None):
+        """
+        Returns User instance based on search params
+
+        :param provider_name:
+        :param db_session:
+        :return: User
+        """
         db_session = get_db_session(db_session)
         query = db_session.query(cls.models_proxy.User)
         query = query.filter(cls.model.external_id == external_id)