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/forms | |
parent | 359813517e3382c527125fe673fa89f0fd0742c0 (diff) |
started work on automatic documentation
Diffstat (limited to 'docs/_build/html/autoapi/app/forms')
-rw-r--r-- | docs/_build/html/autoapi/app/forms/app_forms/index.html | 209 | ||||
-rw-r--r-- | docs/_build/html/autoapi/app/forms/index.html | 114 |
2 files changed, 323 insertions, 0 deletions
diff --git a/docs/_build/html/autoapi/app/forms/app_forms/index.html b/docs/_build/html/autoapi/app/forms/app_forms/index.html new file mode 100644 index 0000000..cc60e1e --- /dev/null +++ b/docs/_build/html/autoapi/app/forms/app_forms/index.html @@ -0,0 +1,209 @@ + +<!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.forms.app_forms — 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.forms.app_forms"> +<span id="app-forms-app-forms"></span><h1><a class="reference internal" href="#module-app.forms.app_forms" title="app.forms.app_forms"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.forms.app_forms</span></code></a><a class="headerlink" href="#module-app.forms.app_forms" 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="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.forms.app_forms.MyForm" title="app.forms.app_forms.MyForm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MyForm</span></code></a></p></td> +<td><p>Flask-specific subclass of WTForms <code class="xref py py-class docutils literal notranslate"><span class="pre">Form</span></code>.</p></td> +</tr> +<tr class="row-even"><td><p><a class="reference internal" href="#app.forms.app_forms.UserSignUp" title="app.forms.app_forms.UserSignUp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UserSignUp</span></code></a></p></td> +<td><p>Flask-specific subclass of WTForms <code class="xref py py-class docutils literal notranslate"><span class="pre">Form</span></code>.</p></td> +</tr> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.forms.app_forms.UserLogIn" title="app.forms.app_forms.UserLogIn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UserLogIn</span></code></a></p></td> +<td><p>Flask-specific subclass of WTForms <code class="xref py py-class docutils literal notranslate"><span class="pre">Form</span></code>.</p></td> +</tr> +</tbody> +</table> +<dl class="py class"> +<dt class="sig sig-object py" id="app.forms.app_forms.MyForm"> +<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">app.forms.app_forms.</span></span><span class="sig-name descname"><span class="pre">MyForm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">formdata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">_Auto</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.forms.app_forms.MyForm" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">flask_wtf.FlaskForm</span></code></p> +<p>Flask-specific subclass of WTForms <code class="xref py py-class docutils literal notranslate"><span class="pre">Form</span></code>.</p> +<p>If <code class="docutils literal notranslate"><span class="pre">formdata</span></code> is not specified, this will use <code class="xref py py-attr docutils literal notranslate"><span class="pre">flask.request.form</span></code> +and <code class="xref py py-attr docutils literal notranslate"><span class="pre">flask.request.files</span></code>. Explicitly pass <code class="docutils literal notranslate"><span class="pre">formdata=None</span></code> to +prevent this.</p> +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.MyForm.name"> +<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#app.forms.app_forms.MyForm.name" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.MyForm.email"> +<span class="sig-name descname"><span class="pre">email</span></span><a class="headerlink" href="#app.forms.app_forms.MyForm.email" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.MyForm.subject"> +<span class="sig-name descname"><span class="pre">subject</span></span><a class="headerlink" href="#app.forms.app_forms.MyForm.subject" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.MyForm.body"> +<span class="sig-name descname"><span class="pre">body</span></span><a class="headerlink" href="#app.forms.app_forms.MyForm.body" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="app.forms.app_forms.UserSignUp"> +<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">app.forms.app_forms.</span></span><span class="sig-name descname"><span class="pre">UserSignUp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">formdata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">_Auto</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.forms.app_forms.UserSignUp" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">flask_wtf.FlaskForm</span></code></p> +<p>Flask-specific subclass of WTForms <code class="xref py py-class docutils literal notranslate"><span class="pre">Form</span></code>.</p> +<p>If <code class="docutils literal notranslate"><span class="pre">formdata</span></code> is not specified, this will use <code class="xref py py-attr docutils literal notranslate"><span class="pre">flask.request.form</span></code> +and <code class="xref py py-attr docutils literal notranslate"><span class="pre">flask.request.files</span></code>. Explicitly pass <code class="docutils literal notranslate"><span class="pre">formdata=None</span></code> to +prevent this.</p> +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.UserSignUp.first_name"> +<span class="sig-name descname"><span class="pre">first_name</span></span><a class="headerlink" href="#app.forms.app_forms.UserSignUp.first_name" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.UserSignUp.last_name"> +<span class="sig-name descname"><span class="pre">last_name</span></span><a class="headerlink" href="#app.forms.app_forms.UserSignUp.last_name" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.UserSignUp.email"> +<span class="sig-name descname"><span class="pre">email</span></span><a class="headerlink" href="#app.forms.app_forms.UserSignUp.email" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.UserSignUp.password"> +<span class="sig-name descname"><span class="pre">password</span></span><a class="headerlink" href="#app.forms.app_forms.UserSignUp.password" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +<dl class="py class"> +<dt class="sig sig-object py" id="app.forms.app_forms.UserLogIn"> +<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">app.forms.app_forms.</span></span><span class="sig-name descname"><span class="pre">UserLogIn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">formdata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">_Auto</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.forms.app_forms.UserLogIn" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">flask_wtf.FlaskForm</span></code></p> +<p>Flask-specific subclass of WTForms <code class="xref py py-class docutils literal notranslate"><span class="pre">Form</span></code>.</p> +<p>If <code class="docutils literal notranslate"><span class="pre">formdata</span></code> is not specified, this will use <code class="xref py py-attr docutils literal notranslate"><span class="pre">flask.request.form</span></code> +and <code class="xref py py-attr docutils literal notranslate"><span class="pre">flask.request.files</span></code>. Explicitly pass <code class="docutils literal notranslate"><span class="pre">formdata=None</span></code> to +prevent this.</p> +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.UserLogIn.email"> +<span class="sig-name descname"><span class="pre">email</span></span><a class="headerlink" href="#app.forms.app_forms.UserLogIn.email" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.forms.app_forms.UserLogIn.password"> +<span class="sig-name descname"><span class="pre">password</span></span><a class="headerlink" href="#app.forms.app_forms.UserLogIn.password" title="Permalink to this definition">¶</a></dt> +<dd></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/forms/app_forms/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/forms/index.html b/docs/_build/html/autoapi/app/forms/index.html new file mode 100644 index 0000000..bae3ec2 --- /dev/null +++ b/docs/_build/html/autoapi/app/forms/index.html @@ -0,0 +1,114 @@ + +<!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.forms — 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.forms"> +<span id="app-forms"></span><h1><a class="reference internal" href="#module-app.forms" title="app.forms"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.forms</span></code></a><a class="headerlink" href="#module-app.forms" 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="app_forms/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.forms.app_forms</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/forms/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file |