started work on automatic documentation

8 files changed, 300 insertions, 0 deletions

diff --git a/docs/_build/html/_sources/autoapi/app/tests/conftest/index.rst.txt b/docs/_build/html/_sources/autoapi/app/tests/conftest/index.rst.txt
new file mode 100644
index 0000000..9be1b50
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/tests/conftest/index.rst.txt
@@ -0,0 +1,35 @@
+:mod:`app.tests.conftest`
+=========================
+
+.. py:module:: app.tests.conftest
+
+.. autoapi-nested-parse::
+
+   Configuration with basic fixtures
+
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.tests.conftest.app
+   app.tests.conftest.client
+
+
+
+.. function:: app()
+
+   Special configurations for tests
+
+   We use a dummy database and initialise it.
+
+
+.. function:: client(app)
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/tests/index.rst.txt b/docs/_build/html/_sources/autoapi/app/tests/index.rst.txt
new file mode 100644
index 0000000..201c641
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/tests/index.rst.txt
@@ -0,0 +1,26 @@
+:mod:`app.tests`
+================
+
+.. py:module:: app.tests
+
+.. autoapi-nested-parse::
+
+   PyTest Modules for Unit Testing
+
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   conftest/index.rst
+   test_admin/index.rst
+   test_cli/index.rst
+   test_fastapi/index.rst
+   test_forms/index.rst
+   test_models/index.rst
+   test_views/index.rst
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/tests/test_admin/index.rst.txt b/docs/_build/html/_sources/autoapi/app/tests/test_admin/index.rst.txt
new file mode 100644
index 0000000..45e0a95
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/tests/test_admin/index.rst.txt
@@ -0,0 +1,32 @@
+:mod:`app.tests.test_admin`
+===========================
+
+.. py:module:: app.tests.test_admin
+
+.. autoapi-nested-parse::
+
+   Test(s) for Admin Portal
+
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.tests.test_admin.test_admin
+
+
+
+.. function:: test_admin(app, client)
+
+   Test Admin Portal
+
+   We use the cli-runner to run the admin-create command.
+   Then we check if the admin portal is accessible to the newly created superuser.
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/tests/test_cli/index.rst.txt b/docs/_build/html/_sources/autoapi/app/tests/test_cli/index.rst.txt
new file mode 100644
index 0000000..8e1241c
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/tests/test_cli/index.rst.txt
@@ -0,0 +1,31 @@
+:mod:`app.tests.test_cli`
+=========================
+
+.. py:module:: app.tests.test_cli
+
+.. autoapi-nested-parse::
+
+   Test(s) for CLI Commands
+
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.tests.test_cli.test_database_commands
+
+
+
+.. function:: test_database_commands(app, client)
+
+   Test for Database CLI Commands
+
+   Test for initialisation, creation and admin user creation.
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/tests/test_fastapi/index.rst.txt b/docs/_build/html/_sources/autoapi/app/tests/test_fastapi/index.rst.txt
new file mode 100644
index 0000000..ba608e5
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/tests/test_fastapi/index.rst.txt
@@ -0,0 +1,52 @@
+:mod:`app.tests.test_fastapi`
+=============================
+
+.. py:module:: app.tests.test_fastapi
+
+.. autoapi-nested-parse::
+
+   Test(s) for FastAPI Inegration
+
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.tests.test_fastapi.test_fastapi
+   app.tests.test_fastapi.test_fastapi_user_details
+
+
+
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+   app.tests.test_fastapi.fastapi_client
+
+
+.. data:: fastapi_client
+   
+
+   
+
+.. function:: test_fastapi(app, client)
+
+   Basic Version Test
+
+   Check if endpoint is accessible
+
+
+.. function:: test_fastapi_user_details(app, client)
+
+   Basic User Test
+
+   Check if DB is accessible to the FastAPI App
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/tests/test_forms/index.rst.txt b/docs/_build/html/_sources/autoapi/app/tests/test_forms/index.rst.txt
new file mode 100644
index 0000000..d49eab1
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/tests/test_forms/index.rst.txt
@@ -0,0 +1,37 @@
+:mod:`app.tests.test_forms`
+===========================
+
+.. py:module:: app.tests.test_forms
+
+.. autoapi-nested-parse::
+
+   Test(s) for Forms
+
+   Tests the forms and their validations
+
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.tests.test_forms.test_incorrect_forms
+   app.tests.test_forms.test_contactus
+
+
+
+.. function:: test_incorrect_forms(app, client)
+
+   Simulate Invalid Forms
+
+
+.. function:: test_contactus(app, client)
+
+   Test Valid Form Submission
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/tests/test_models/index.rst.txt b/docs/_build/html/_sources/autoapi/app/tests/test_models/index.rst.txt
new file mode 100644
index 0000000..23db7d4
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/tests/test_models/index.rst.txt
@@ -0,0 +1,29 @@
+:mod:`app.tests.test_models`
+============================
+
+.. py:module:: app.tests.test_models
+
+.. autoapi-nested-parse::
+
+   Test(s) for Database Models
+
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.tests.test_models.test_usermodel
+
+
+
+.. function:: test_usermodel(app, client)
+
+   Test User Model
+
+
diff --git a/docs/_build/html/_sources/autoapi/app/tests/test_views/index.rst.txt b/docs/_build/html/_sources/autoapi/app/tests/test_views/index.rst.txt
new file mode 100644
index 0000000..ebcb77a
--- /dev/null
+++ b/docs/_build/html/_sources/autoapi/app/tests/test_views/index.rst.txt
@@ -0,0 +1,58 @@
+:mod:`app.tests.test_views`
+===========================
+
+.. py:module:: app.tests.test_views
+
+.. autoapi-nested-parse::
+
+   Test(s) for Flask Views
+
+
+
+Module Contents
+---------------
+
+
+Functions
+~~~~~~~~~
+
+.. autoapisummary::
+
+   app.tests.test_views.test_visitors
+   app.tests.test_views.test_user_auth_flow
+
+
+
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+   app.tests.test_views.ts
+   app.tests.test_views.data2check_visitors
+
+
+.. data:: ts
+   
+
+   To create confirmation tokens
+
+
+.. data:: data2check_visitors
+   
+
+   Dictionary of Path, Expected Status Code and Data to Test for Visitors
+
+
+.. function:: test_visitors(app, client)
+
+   Test if Vistors get expected endpoints and status codes
+
+
+.. function:: test_user_auth_flow(app, client)
+
+   Test User Authentication Flow
+
+   Tests Registeration, Email-Confirmation and Log-in along with appropriate redirects.
+
+