documentation: improvements

ergo · Nov 16, 2016 · 214156d · 214156d
1 parent a5d61e9
commit 214156d
Show file tree

Hide file tree

Showing 20 changed files with 1,007 additions and 531 deletions.
diff --git a/docs/api/models.rst b/docs/api/models.rst
@@ -2,44 +2,67 @@
 Models
 ======
 
+UserMixin
+=========
 
 .. autoclass:: ziggurat_foundations.models.user.UserMixin
     :members:
-
+
+ExternalIdentityMixin
+=====================
 
 .. autoclass:: ziggurat_foundations.models.external_identity.ExternalIdentityMixin
     :members:
-
+
+GroupMixin
+==========
 
 .. autoclass:: ziggurat_foundations.models.group.GroupMixin
     :members:
-
+
+GroupPermissionMixin
+====================
 
 .. autoclass:: ziggurat_foundations.models.group_permission.GroupPermissionMixin
     :members:
-
+
+UserPermissionMixin
+===================
 
 .. autoclass:: ziggurat_foundations.models.user_permission.UserPermissionMixin
     :members:
-
+
+UserGroupMixin
+==============
 
 .. autoclass:: ziggurat_foundations.models.user_group.UserGroupMixin
     :members:
-
+
+GroupResourcePermissionMixin
+============================
 
 .. autoclass:: ziggurat_foundations.models.group_resource_permission.GroupResourcePermissionMixin
     :members:
 
+UserResourcePermissionMixin
+===========================
 
 .. autoclass:: ziggurat_foundations.models.user_resource_permission.UserResourcePermissionMixin
     :members:
-
+
+ResourceMixin
+=============
 
 .. autoclass:: ziggurat_foundations.models.resource.ResourceMixin
     :members:
-
+
+get_db_session
+==============
+
 .. autofunction:: ziggurat_foundations.models.base.get_db_session
 
+BaseModel
+=========
 
 .. autoclass:: ziggurat_foundations.models.base.BaseModel
     :members:
diff --git a/docs/api/services.rst b/docs/api/services.rst
@@ -3,29 +3,56 @@ Services
 ========
 
 
+UserService
+===========
+
 .. autoclass:: ziggurat_foundations.models.services.user.UserService
     :members:
 
+ExternalIdentityService
+=======================
 
 .. autoclass:: ziggurat_foundations.models.services.external_identity.ExternalIdentityService
     :members:
 
+GroupService
+============
 
 .. autoclass:: ziggurat_foundations.models.services.group.GroupService
     :members:
 
+GroupPermissionService
+======================
 
 .. autoclass:: ziggurat_foundations.models.services.group_permission.GroupPermissionService
     :members:
 
+UserPermissionService
+=====================
 
 .. autoclass:: ziggurat_foundations.models.services.user_permission.UserPermissionService
     :members:
 
+UserResourcePermissionService
+=============================
 
 .. autoclass:: ziggurat_foundations.models.services.user_resource_permission.UserResourcePermissionService
     :members:
 
+ResourceService
+===============
 
 .. autoclass:: ziggurat_foundations.models.services.resource.ResourceService
     :members:
+
+ResourceTreeService
+===================
+
+.. autoclass:: ziggurat_foundations.models.services.resource_tree.ResourceTreeService
+    :members:
+
+ResourceTreeServicePostgreSQL
+=============================
+
+.. autoclass:: ziggurat_foundations.models.services.resource_tree_postgres.ResourceTreeServicePostgreSQL
+    :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -102,23 +102,20 @@
 
 
 # -- Options for HTML output ---------------------------------------------------
-import itcase_sphinx_theme
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'itcase'
+html_theme = 'pyramid'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    'github_button': True,
-    'github_user': 'Ergo',
-    'github_repo': 'ziggurat_foundations',
+
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [itcase_sphinx_theme.get_html_themes_path()]
+html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".