diff options
| author | Navan Chauhan <navanchauhan@gmail.com> | 2021-06-07 13:59:08 +0530 |
|---|---|---|
| committer | Navan Chauhan <navanchauhan@gmail.com> | 2021-06-07 13:59:08 +0530 |
| commit | 3a708b304319afe84ebf3d40ecebabe6acc339f3 (patch) | |
| tree | b72f391dbe4d5370394c546f94e10d6edaa17a63 /docs/_build/html/autoapi/app/views | |
| parent | 359813517e3382c527125fe673fa89f0fd0742c0 (diff) | |
started work on automatic documentation
Diffstat (limited to 'docs/_build/html/autoapi/app/views')
| -rw-r--r-- | docs/_build/html/autoapi/app/views/admin/index.html | 159 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/views/auth/index.html | 203 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/views/error_pages/index.html | 157 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/views/index.html | 117 | ||||
| -rw-r--r-- | docs/_build/html/autoapi/app/views/main/index.html | 141 |
5 files changed, 777 insertions, 0 deletions
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 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.views.admin — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.views.admin"> +<span id="app-views-admin"></span><h1><a class="reference internal" href="#module-app.views.admin" title="app.views.admin"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.admin</span></code></a><a class="headerlink" href="#module-app.views.admin" title="Permalink to this headline">¶</a></h1> +<p>SuperUser/Admin portal using flask-admin</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="classes"> +<h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.admin.ModelView" title="app.views.admin.ModelView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ModelView</span></code></a></p></td> +<td><p>Our extended ModelView Class</p></td> +</tr> +</tbody> +</table> +</section> +<section id="attributes"> +<h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.admin.admin" title="app.views.admin.admin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">admin</span></code></a></p></td> +<td><p>Initialised Admin Portal</p></td> +</tr> +</tbody> +</table> +<dl class="py data"> +<dt class="sig sig-object py" id="app.views.admin.admin"> +<span class="sig-prename descclassname"><span class="pre">app.views.admin.</span></span><span class="sig-name descname"><span class="pre">admin</span></span><a class="headerlink" href="#app.views.admin.admin" title="Permalink to this definition">¶</a></dt> +<dd><p>Initialised Admin Portal</p> +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="app.views.admin.ModelView"> +<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">app.views.admin.</span></span><span class="sig-name descname"><span class="pre">ModelView</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">static_folder</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">menu_class_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">menu_icon_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">menu_icon_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.views.admin.ModelView" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">flask_admin.contrib.sqla.ModelView</span></code></p> +<p>Our extended ModelView Class</p> +<p>Refer to Flask-Admin Docs for more details</p> +<p><a class="reference external" href="https://flask-admin.readthedocs.io/en/latest/introduction/?highlight=ModelView#modelview-configuration-attributes">https://flask-admin.readthedocs.io/en/latest/introduction/?highlight=ModelView#modelview-configuration-attributes</a></p> +<dl class="py method"> +<dt class="sig sig-object py" id="app.views.admin.ModelView.is_accessible"> +<span class="sig-name descname"><span class="pre">is_accessible</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.views.admin.ModelView.is_accessible" title="Permalink to this definition">¶</a></dt> +<dd><p>This function checks if a user should be given access or not</p> +</dd></dl> + +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/views/admin/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ 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 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.views.auth — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.views.auth"> +<span id="app-views-auth"></span><h1><a class="reference internal" href="#module-app.views.auth" title="app.views.auth"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.auth</span></code></a><a class="headerlink" href="#module-app.views.auth" title="Permalink to this headline">¶</a></h1> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.auth.register_user" title="app.views.auth.register_user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">register_user</span></code></a>()</p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.views.auth.signin_user" title="app.views.auth.signin_user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">signin_user</span></code></a>()</p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.auth.login_with_google" title="app.views.auth.login_with_google"><code class="xref py py-obj docutils literal notranslate"><span class="pre">login_with_google</span></code></a>()</p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.views.auth.login_with_google_auth" title="app.views.auth.login_with_google_auth"><code class="xref py py-obj docutils literal notranslate"><span class="pre">login_with_google_auth</span></code></a>()</p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.auth.confirm_email" title="app.views.auth.confirm_email"><code class="xref py py-obj docutils literal notranslate"><span class="pre">confirm_email</span></code></a>()</p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.views.auth.user_dashboard" title="app.views.auth.user_dashboard"><code class="xref py py-obj docutils literal notranslate"><span class="pre">user_dashboard</span></code></a>()</p></td> +<td><p></p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.auth.logout" title="app.views.auth.logout"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logout</span></code></a>()</p></td> +<td><p></p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.views.auth.unauthorized" title="app.views.auth.unauthorized"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unauthorized</span></code></a>()</p></td> +<td><p></p></td> +</tr> +</tbody> +</table> +</section> +<section id="attributes"> +<h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.auth.ts" title="app.views.auth.ts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ts</span></code></a></p></td> +<td><p></p></td> +</tr> +</tbody> +</table> +<dl class="py data"> +<dt class="sig sig-object py" id="app.views.auth.ts"> +<span class="sig-prename descclassname"><span class="pre">app.views.auth.</span></span><span class="sig-name descname"><span class="pre">ts</span></span><a class="headerlink" href="#app.views.auth.ts" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.auth.register_user"> +<span class="sig-prename descclassname"><span class="pre">app.views.auth.</span></span><span class="sig-name descname"><span class="pre">register_user</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.auth.register_user" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.auth.signin_user"> +<span class="sig-prename descclassname"><span class="pre">app.views.auth.</span></span><span class="sig-name descname"><span class="pre">signin_user</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.auth.signin_user" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.auth.login_with_google"> +<span class="sig-prename descclassname"><span class="pre">app.views.auth.</span></span><span class="sig-name descname"><span class="pre">login_with_google</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.auth.login_with_google" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.auth.login_with_google_auth"> +<span class="sig-prename descclassname"><span class="pre">app.views.auth.</span></span><span class="sig-name descname"><span class="pre">login_with_google_auth</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.auth.login_with_google_auth" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.auth.confirm_email"> +<span class="sig-prename descclassname"><span class="pre">app.views.auth.</span></span><span class="sig-name descname"><span class="pre">confirm_email</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.auth.confirm_email" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.auth.user_dashboard"> +<span class="sig-prename descclassname"><span class="pre">app.views.auth.</span></span><span class="sig-name descname"><span class="pre">user_dashboard</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.auth.user_dashboard" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.auth.logout"> +<span class="sig-prename descclassname"><span class="pre">app.views.auth.</span></span><span class="sig-name descname"><span class="pre">logout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.auth.logout" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.auth.unauthorized"> +<span class="sig-prename descclassname"><span class="pre">app.views.auth.</span></span><span class="sig-name descname"><span class="pre">unauthorized</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.auth.unauthorized" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/views/auth/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ 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 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.views.error_pages — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.views.error_pages"> +<span id="app-views-error-pages"></span><h1><a class="reference internal" href="#module-app.views.error_pages" title="app.views.error_pages"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.error_pages</span></code></a><a class="headerlink" href="#module-app.views.error_pages" title="Permalink to this headline">¶</a></h1> +<p>This file describes the errors and the message the user should see.</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.error_pages.simulate_500" title="app.views.error_pages.simulate_500"><code class="xref py py-obj docutils literal notranslate"><span class="pre">simulate_500</span></code></a>()</p></td> +<td><p>Used to simulate a error 500 for test coverage of 500 handling</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.views.error_pages.page_forbidden" title="app.views.error_pages.page_forbidden"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_forbidden</span></code></a>(e)</p></td> +<td><p>Thrown when a user accesses a page with @flask_login.login_required</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.error_pages.page_not_found" title="app.views.error_pages.page_not_found"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_not_found</span></code></a>(e)</p></td> +<td><p>Page for resource or file nout found</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.views.error_pages.page_server_error" title="app.views.error_pages.page_server_error"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_server_error</span></code></a>(e)</p></td> +<td><p>Page for internal server error</p></td> +</tr> +</tbody> +</table> +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.error_pages.simulate_500"> +<span class="sig-prename descclassname"><span class="pre">app.views.error_pages.</span></span><span class="sig-name descname"><span class="pre">simulate_500</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.error_pages.simulate_500" title="Permalink to this definition">¶</a></dt> +<dd><p>Used to simulate a error 500 for test coverage of 500 handling</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.error_pages.page_forbidden"> +<span class="sig-prename descclassname"><span class="pre">app.views.error_pages.</span></span><span class="sig-name descname"><span class="pre">page_forbidden</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">e</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.views.error_pages.page_forbidden" title="Permalink to this definition">¶</a></dt> +<dd><p>Thrown when a user accesses a page with @flask_login.login_required</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.error_pages.page_not_found"> +<span class="sig-prename descclassname"><span class="pre">app.views.error_pages.</span></span><span class="sig-name descname"><span class="pre">page_not_found</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">e</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.views.error_pages.page_not_found" title="Permalink to this definition">¶</a></dt> +<dd><p>Page for resource or file nout found</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.error_pages.page_server_error"> +<span class="sig-prename descclassname"><span class="pre">app.views.error_pages.</span></span><span class="sig-name descname"><span class="pre">page_server_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">e</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.views.error_pages.page_server_error" title="Permalink to this definition">¶</a></dt> +<dd><p>Page for internal server error</p> +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/views/error_pages/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ 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 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.views — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css" /> + <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> + <script src="../../../_static/jquery.js"></script> + <script src="../../../_static/underscore.js"></script> + <script src="../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + + <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.views"> +<span id="app-views"></span><h1><a class="reference internal" href="#module-app.views" title="app.views"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views</span></code></a><a class="headerlink" href="#module-app.views" title="Permalink to this headline">¶</a></h1> +<section id="submodules"> +<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2> +<div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="admin/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.admin</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="auth/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.auth</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="error_pages/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.error_pages</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="main/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.main</span></code></a></li> +</ul> +</div> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../_sources/autoapi/app/views/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ 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 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.views.main — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" /> + <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script> + <script src="../../../../_static/jquery.js"></script> + <script src="../../../../_static/underscore.js"></script> + <script src="../../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../../genindex.html" /> + <link rel="search" title="Search" href="../../../../search.html" /> + + <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.views.main"> +<span id="app-views-main"></span><h1><a class="reference internal" href="#module-app.views.main" title="app.views.main"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.main</span></code></a><a class="headerlink" href="#module-app.views.main" title="Permalink to this headline">¶</a></h1> +<p>This is the main views module.</p> +<p>You should import all other views into this file rather than individually importing in __init__.py</p> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="functions"> +<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.main.index" title="app.views.main.index"><code class="xref py py-obj docutils literal notranslate"><span class="pre">index</span></code></a>()</p></td> +<td><p>The view for the landing page.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.views.main.contact_us" title="app.views.main.contact_us"><code class="xref py py-obj docutils literal notranslate"><span class="pre">contact_us</span></code></a>()</p></td> +<td><p>A simple contact us form with basic validation.</p></td> +</tr> +</tbody> +</table> +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.main.index"> +<span class="sig-prename descclassname"><span class="pre">app.views.main.</span></span><span class="sig-name descname"><span class="pre">index</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.main.index" title="Permalink to this definition">¶</a></dt> +<dd><p>The view for the landing page.</p> +</dd></dl> + +<dl class="py function"> +<dt class="sig sig-object py" id="app.views.main.contact_us"> +<span class="sig-prename descclassname"><span class="pre">app.views.main.</span></span><span class="sig-name descname"><span class="pre">contact_us</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.main.contact_us" title="Permalink to this definition">¶</a></dt> +<dd><p>A simple contact us form with basic validation.</p> +<p>This dummy form has not been linked to any database.</p> +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../../_sources/autoapi/app/views/main/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file |