Adding Sphinx AutoDoc for the codebase

server/documentation/api/authentication.rst

@@ -63,9 +63,12 @@ Authentication API
 
     :<header Accept: Response content type depends on :mailheader:`Accept` header
     :<header Authorization: Encoded basic authorization
+    :<header Content-Type: Application/json
+    :<json string note: Note to attach to the created token
+    :<json iso8601 expirationTime: Expiration time for the userToken
     :>header Content-Type: Depends on :mailheader:`Accept` header of request
-    :>json datetime creationTime: Creation time for the userToken
-    :>json datetime expirationTime: Expiration time for the userToken
+    :>json iso8601 creationTime: Creation time for the userToken
+    :>json iso8601 expirationTime: Expiration time for the userToken
     :>json boolean enabled: Whether the userToken is enabled
     :>json string token: UserToken to use for further authentication
     :>json int version: Version for the object
@@ -100,7 +103,7 @@ Authentication API
     :<header Accept: Response content type depends on :mailheader:`Accept` header
     :<header Authorization: Encoded token authorization
     :>header Content-Type: Depends on :mailheader:`Accept` header of request
-    :>json datetime lastLoginTime: Updated lastLoginTime for the user
+    :>json iso8601 lastLoginTime: Updated lastLoginTime for the user
     :statuscode 200: User last_login_time successfully bumped
     :statuscode 401: Authorization failed
 

server/documentation/api/index.rst

@@ -1,5 +1,5 @@
-Atheneum API documentation
-==========================
+Atheneum HTTP API
+=================
 
 .. toctree::
    :maxdepth: 2

server/documentation/api/user.rst

@@ -87,8 +87,8 @@ User API
     :<header Accept: Response content type depends on :mailheader:`Accept` header
     :<header Authorization: The encoded basic authorization
     :>header Content-Type: Depends on :mailheader:`Accept` header of request
-    :>json datetime creationTime: Creation time for the user
-    :>json datetime lastLoginTime: When the user last logged in, or was last bumped
+    :>json iso8601 creationTime: Creation time for the user
+    :>json iso8601 lastLoginTime: When the user last logged in, or was last bumped
     :>json string name: The user name
     :>json string role: The role assigned to the user
     :>json int version: Version information
@@ -135,14 +135,14 @@ User API
     :<header Accept: Response content type depends on :mailheader:`Accept` header
     :<header Authorization: Encoded token authorization
     :<header Content-Type: application/json
-    :<json datetime createDateTime: Update createDateTime (Administrator Only)
-    :<json datetime lastLoginTime: Update lastLoginTime
+    :<json iso8601 createDateTime: Update createDateTime (Administrator Only)
+    :<json iso8601 lastLoginTime: Update lastLoginTime
     :<json string name: Update user name (Administrator Only)
     :<json string role: Update user role (Must be less than or equal to the role authenticating the action)
     :<json int version: Must match the latest version of the user
     :>header Content-Type: Depends on :mailheader:`Accept` header of request
-    :>json datetime creationTime: Creation time for the user
-    :>json datetime lastLoginTime: When the user last logged in, or was last bumped
+    :>json iso8601 creationTime: Creation time for the user
+    :>json iso8601 lastLoginTime: When the user last logged in, or was last bumped
     :>json string name: The user name
     :>json string role: The role assigned to the user
     :>json int version: Version information
@@ -193,7 +193,7 @@ User API
     :<json string password: Password to use
     :<json string role: Role to assign to the user (Must be less than or equal to the role of the authenticating user)
     :>header Content-Type: Depends on :mailheader:`Accept` header of request
-    :>json datetime creationTime: Datetime the user was created
+    :>json iso8601 creationTime: Datetime the user was created
     :>json string name: Name of the created user
     :>json string role: Role of the created user
     :>json int version: Version number of the created user

server/documentation/conf.py

@@ -12,9 +12,9 @@
 # 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.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
 
 
 # -- Project information -----------------------------------------------------
@@ -40,7 +40,8 @@ release = '2018.8.1'
 # ones.
 extensions = [
     'sphinxcontrib.httpdomain',
-    'sphinxjsondomain'
+    'sphinxjsondomain',
+    'sphinx.ext.autodoc'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

server/documentation/index.rst

@@ -12,6 +12,7 @@ Welcome to Atheneum's documentation!
 
    introduction
    api/index
+   server/modules
 
 Indices and tables
 ==================

server/documentation/server/atheneum.api.rst

@@ -0,0 +1,46 @@
+atheneum.api package
+====================
+
+Submodules
+----------
+
+atheneum.api.authentication\_api module
+---------------------------------------
+
+.. automodule:: atheneum.api.authentication_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.api.decorators module
+------------------------------
+
+.. automodule:: atheneum.api.decorators
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.api.model module
+-------------------------
+
+.. automodule:: atheneum.api.model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.api.user\_api module
+-----------------------------
+
+.. automodule:: atheneum.api.user_api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: atheneum.api
+    :members:
+    :undoc-members:
+    :show-inheritance:

server/documentation/server/atheneum.middleware.rst

@@ -0,0 +1,22 @@
+atheneum.middleware package
+===========================
+
+Submodules
+----------
+
+atheneum.middleware.authentication\_middleware module
+-----------------------------------------------------
+
+.. automodule:: atheneum.middleware.authentication_middleware
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: atheneum.middleware
+    :members:
+    :undoc-members:
+    :show-inheritance:

server/documentation/server/atheneum.model.rst

@@ -0,0 +1,22 @@
+atheneum.model package
+======================
+
+Submodules
+----------
+
+atheneum.model.user\_model module
+---------------------------------
+
+.. automodule:: atheneum.model.user_model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: atheneum.model
+    :members:
+    :undoc-members:
+    :show-inheritance:

server/documentation/server/atheneum.rst

@@ -0,0 +1,49 @@
+atheneum package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    atheneum.api
+    atheneum.middleware
+    atheneum.model
+    atheneum.service
+    atheneum.utility
+
+Submodules
+----------
+
+atheneum.db module
+------------------
+
+.. automodule:: atheneum.db
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.default\_settings module
+---------------------------------
+
+.. automodule:: atheneum.default_settings
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.errors module
+----------------------
+
+.. automodule:: atheneum.errors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: atheneum
+    :members:
+    :undoc-members:
+    :show-inheritance:

server/documentation/server/atheneum.service.rst

@@ -0,0 +1,70 @@
+atheneum.service package
+========================
+
+Submodules
+----------
+
+atheneum.service.authentication\_service module
+-----------------------------------------------
+
+.. automodule:: atheneum.service.authentication_service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.service.patch\_service module
+--------------------------------------
+
+.. automodule:: atheneum.service.patch_service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.service.role\_service module
+-------------------------------------
+
+.. automodule:: atheneum.service.role_service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.service.transformation\_service module
+-----------------------------------------------
+
+.. automodule:: atheneum.service.transformation_service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.service.user\_service module
+-------------------------------------
+
+.. automodule:: atheneum.service.user_service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.service.user\_token\_service module
+--------------------------------------------
+
+.. automodule:: atheneum.service.user_token_service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.service.validation\_service module
+-------------------------------------------
+
+.. automodule:: atheneum.service.validation_service
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: atheneum.service
+    :members:
+    :undoc-members:
+    :show-inheritance:

server/documentation/server/atheneum.utility.rst

@@ -0,0 +1,46 @@
+atheneum.utility package
+========================
+
+Submodules
+----------
+
+atheneum.utility.authentication\_utility module
+-----------------------------------------------
+
+.. automodule:: atheneum.utility.authentication_utility
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.utility.json\_utility module
+-------------------------------------
+
+.. automodule:: atheneum.utility.json_utility
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.utility.pagination\_utility module
+-------------------------------------------
+
+.. automodule:: atheneum.utility.pagination_utility
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+atheneum.utility.session\_utility module
+----------------------------------------
+
+.. automodule:: atheneum.utility.session_utility
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: atheneum.utility
+    :members:
+    :undoc-members:
+    :show-inheritance:

server/documentation/server/modules.rst

@@ -0,0 +1,7 @@
+Atheneum Server API
+===================
+
+.. toctree::
+   :maxdepth: 4
+
+   atheneum