started work on automatic documentation

5 files changed, 222 insertions, 0 deletions

diff --git a/docs/_build/html/_sources/autoapi/app/views/admin/index.rst.txt b/docs/_build/html/_sources/autoapi/app/views/admin/index.rst.txt
new file mode 100644
index 0000000..f9ea549
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/views/admin/index.rst.txt
@@ -0,0 +1,55 @@
+:mod:`app.views.admin`
+======================
+
+.. py:module:: app.views.admin
+
+.. autoapi-nested-parse::
+
+   SuperUser/Admin portal using flask-admin
+
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   app.views.admin.ModelView
+
+
+
+
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+   app.views.admin.admin
+
+
+.. data:: admin
+   
+
+   Initialised Admin Portal
+
+
+.. class:: ModelView(model, session, name=None, category=None, endpoint=None, url=None, static_folder=None, menu_class_name=None, menu_icon_type=None, menu_icon_value=None)
+
+
+   Bases: :py:obj:`flask_admin.contrib.sqla.ModelView`
+
+   Our extended ModelView Class
+
+   Refer to Flask-Admin Docs for more details
+
+   https://flask-admin.readthedocs.io/en/latest/introduction/?highlight=ModelView#modelview-configuration-attributes
+
+   .. method:: is_accessible(self)
+
+      This function checks if a user should be given access or not
+
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/views/auth/index.rst.txt b/docs/_build/html/_sources/autoapi/app/views/auth/index.rst.txt
new file mode 100644
index 0000000..5dcf9d7
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/views/auth/index.rst.txt
@@ -0,0 +1,63 @@
+:mod:`app.views.auth`
+=====================
+
+.. py:module:: app.views.auth
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.views.auth.register_user
+   app.views.auth.signin_user
+   app.views.auth.login_with_google
+   app.views.auth.login_with_google_auth
+   app.views.auth.confirm_email
+   app.views.auth.user_dashboard
+   app.views.auth.logout
+   app.views.auth.unauthorized
+
+
+
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+   app.views.auth.ts
+
+
+.. data:: ts
+   
+
+   
+
+.. function:: register_user()
+
+
+.. function:: signin_user()
+
+
+.. function:: login_with_google()
+
+
+.. function:: login_with_google_auth()
+
+
+.. function:: confirm_email()
+
+
+.. function:: user_dashboard()
+
+
+.. function:: logout()
+
+
+.. function:: unauthorized()
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/views/error_pages/index.rst.txt b/docs/_build/html/_sources/autoapi/app/views/error_pages/index.rst.txt
new file mode 100644
index 0000000..b0f7d91
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/views/error_pages/index.rst.txt
@@ -0,0 +1,47 @@
+:mod:`app.views.error_pages`
+============================
+
+.. py:module:: app.views.error_pages
+
+.. autoapi-nested-parse::
+
+   This file describes the errors and the message the user should see.
+
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.views.error_pages.simulate_500
+   app.views.error_pages.page_forbidden
+   app.views.error_pages.page_not_found
+   app.views.error_pages.page_server_error
+
+
+
+.. function:: simulate_500()
+
+   Used to simulate a error 500 for test coverage of 500 handling
+
+
+.. function:: page_forbidden(e)
+
+   Thrown when a user accesses a page with @flask_login.login_required
+
+
+.. function:: page_not_found(e)
+
+   Page for resource or file nout found
+
+
+.. function:: page_server_error(e)
+
+   Page for internal server error
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/views/index.rst.txt b/docs/_build/html/_sources/autoapi/app/views/index.rst.txt
new file mode 100644
index 0000000..499df52
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/views/index.rst.txt
@@ -0,0 +1,18 @@
+:mod:`app.views`
+================
+
+.. py:module:: app.views
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   admin/index.rst
+   auth/index.rst
+   error_pages/index.rst
+   main/index.rst
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/views/main/index.rst.txt b/docs/_build/html/_sources/autoapi/app/views/main/index.rst.txt
new file mode 100644
index 0000000..e7c4e7c
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/views/main/index.rst.txt
@@ -0,0 +1,39 @@
+:mod:`app.views.main`
+=====================
+
+.. py:module:: app.views.main
+
+.. autoapi-nested-parse::
+
+   This is the main views module.
+
+   You should import all other views into this file rather than individually importing in __init__.py
+
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.views.main.index
+   app.views.main.contact_us
+
+
+
+.. function:: index()
+
+   The view for the landing page.
+
+
+.. function:: contact_us()
+
+   A simple contact us form with basic validation.
+
+   This dummy form has not been linked to any database.
+
+