From 3a708b304319afe84ebf3d40ecebabe6acc339f3 Mon Sep 17 00:00:00 2001 From: Navan Chauhan Date: Mon, 7 Jun 2021 13:59:08 +0530 Subject: started work on automatic documentation --- .../_build/html/autoapi/app/views/admin/index.html | 159 ++++++++++++++++ docs/_build/html/autoapi/app/views/auth/index.html | 203 +++++++++++++++++++++ .../html/autoapi/app/views/error_pages/index.html | 157 ++++++++++++++++ docs/_build/html/autoapi/app/views/index.html | 117 ++++++++++++ docs/_build/html/autoapi/app/views/main/index.html | 141 ++++++++++++++ 5 files changed, 777 insertions(+) create mode 100644 docs/_build/html/autoapi/app/views/admin/index.html create mode 100644 docs/_build/html/autoapi/app/views/auth/index.html create mode 100644 docs/_build/html/autoapi/app/views/error_pages/index.html create mode 100644 docs/_build/html/autoapi/app/views/index.html create mode 100644 docs/_build/html/autoapi/app/views/main/index.html (limited to 'docs/_build/html/autoapi/app/views') diff --git a/docs/_build/html/autoapi/app/views/admin/index.html b/docs/_build/html/autoapi/app/views/admin/index.html new file mode 100644 index 0000000..5339b3a --- /dev/null +++ b/docs/_build/html/autoapi/app/views/admin/index.html @@ -0,0 +1,159 @@ + + + + + + + + + app.views.admin — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views.admin

+

SuperUser/Admin portal using flask-admin

+
+

Module Contents

+
+

Classes

+ ++++ + + + + + +

ModelView

Our extended ModelView Class

+
+
+

Attributes

+ ++++ + + + + + +

admin

Initialised Admin Portal

+
+
+app.views.admin.admin
+

Initialised Admin Portal

+
+ +
+
+class app.views.admin.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: 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

+
+
+is_accessible(self)
+

This function checks if a user should be given access or not

+
+ +
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/views/auth/index.html b/docs/_build/html/autoapi/app/views/auth/index.html new file mode 100644 index 0000000..6a4a773 --- /dev/null +++ b/docs/_build/html/autoapi/app/views/auth/index.html @@ -0,0 +1,203 @@ + + + + + + + + + app.views.auth — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views.auth

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

register_user()

signin_user()

login_with_google()

login_with_google_auth()

confirm_email()

user_dashboard()

logout()

unauthorized()

+
+
+

Attributes

+ ++++ + + + + + +

ts

+
+
+app.views.auth.ts
+
+ +
+
+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()
+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/views/error_pages/index.html b/docs/_build/html/autoapi/app/views/error_pages/index.html new file mode 100644 index 0000000..222d7e5 --- /dev/null +++ b/docs/_build/html/autoapi/app/views/error_pages/index.html @@ -0,0 +1,157 @@ + + + + + + + + + app.views.error_pages — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views.error_pages

+

This file describes the errors and the message the user should see.

+
+

Module Contents

+
+

Functions

+ ++++ + + + + + + + + + + + + + + +

simulate_500()

Used to simulate a error 500 for test coverage of 500 handling

page_forbidden(e)

Thrown when a user accesses a page with @flask_login.login_required

page_not_found(e)

Page for resource or file nout found

page_server_error(e)

Page for internal server error

+
+
+app.views.error_pages.simulate_500()
+

Used to simulate a error 500 for test coverage of 500 handling

+
+ +
+
+app.views.error_pages.page_forbidden(e)
+

Thrown when a user accesses a page with @flask_login.login_required

+
+ +
+
+app.views.error_pages.page_not_found(e)
+

Page for resource or file nout found

+
+ +
+
+app.views.error_pages.page_server_error(e)
+

Page for internal server error

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/views/index.html b/docs/_build/html/autoapi/app/views/index.html new file mode 100644 index 0000000..170f909 --- /dev/null +++ b/docs/_build/html/autoapi/app/views/index.html @@ -0,0 +1,117 @@ + + + + + + + + + app.views — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views

+
+

Submodules

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/docs/_build/html/autoapi/app/views/main/index.html b/docs/_build/html/autoapi/app/views/main/index.html new file mode 100644 index 0000000..8cf93f8 --- /dev/null +++ b/docs/_build/html/autoapi/app/views/main/index.html @@ -0,0 +1,141 @@ + + + + + + + + + app.views.main — SaaS in a Flask 0.1.0 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

app.views.main

+

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

+ ++++ + + + + + + + + +

index()

The view for the landing page.

contact_us()

A simple contact us form with basic validation.

+
+
+app.views.main.index()
+

The view for the landing page.

+
+ +
+
+app.views.main.contact_us()
+

A simple contact us form with basic validation.

+

This dummy form has not been linked to any database.

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2021, Navan Chauhan. + + | + Powered by Sphinx 4.0.2 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file -- cgit v1.2.3