Correction on docs rst, added html build from sphinx

dpgaspar · May 8, 2016 · 9a4cfd0 · 9a4cfd0
1 parent 5a3744a
commit 9a4cfd0
Show file tree

Hide file tree

Showing 201 changed files with 62,767 additions and 1,126 deletions.
diff --git a/docs/_build/doctrees/actions.doctree b/docs/_build/doctrees/actions.doctree
diff --git a/docs/_build/doctrees/addons.doctree b/docs/_build/doctrees/addons.doctree
diff --git a/docs/_build/doctrees/advanced.doctree b/docs/_build/doctrees/advanced.doctree
diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree
diff --git a/docs/_build/doctrees/config.doctree b/docs/_build/doctrees/config.doctree
diff --git a/docs/_build/doctrees/customizing.doctree b/docs/_build/doctrees/customizing.doctree
diff --git a/docs/_build/doctrees/diagrams.doctree b/docs/_build/doctrees/diagrams.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/fabmanager.doctree b/docs/_build/doctrees/fabmanager.doctree
diff --git a/docs/_build/doctrees/generic_datasource.doctree b/docs/_build/doctrees/generic_datasource.doctree
diff --git a/docs/_build/doctrees/i18n.doctree b/docs/_build/doctrees/i18n.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/installation.doctree b/docs/_build/doctrees/installation.doctree
diff --git a/docs/_build/doctrees/intro.doctree b/docs/_build/doctrees/intro.doctree
diff --git a/docs/_build/doctrees/multipledbs.doctree b/docs/_build/doctrees/multipledbs.doctree
diff --git a/docs/_build/doctrees/quickcharts.doctree b/docs/_build/doctrees/quickcharts.doctree
diff --git a/docs/_build/doctrees/quickfiles.doctree b/docs/_build/doctrees/quickfiles.doctree
diff --git a/docs/_build/doctrees/quickhowto.doctree b/docs/_build/doctrees/quickhowto.doctree
diff --git a/docs/_build/doctrees/quickhowto_mongo.doctree b/docs/_build/doctrees/quickhowto_mongo.doctree
diff --git a/docs/_build/doctrees/quickminimal.doctree b/docs/_build/doctrees/quickminimal.doctree
diff --git a/docs/_build/doctrees/relations.doctree b/docs/_build/doctrees/relations.doctree
diff --git a/docs/_build/doctrees/security.doctree b/docs/_build/doctrees/security.doctree
diff --git a/docs/_build/doctrees/templates.doctree b/docs/_build/doctrees/templates.doctree
diff --git a/docs/_build/doctrees/user_registration.doctree b/docs/_build/doctrees/user_registration.doctree
diff --git a/docs/_build/doctrees/versionmigration.doctree b/docs/_build/doctrees/versionmigration.doctree
diff --git a/docs/_build/doctrees/versions.doctree b/docs/_build/doctrees/versions.doctree
diff --git a/docs/_build/doctrees/views.doctree b/docs/_build/doctrees/views.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 076963d0704c77c10c63f49380ba01b4
+config: b741f649aa8e29e7565321b19ad235e7
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_images/blockdiag-08f10482b0afaab4fe198ff2dec64b15d489b182.png b/docs/_build/html/_images/blockdiag-08f10482b0afaab4fe198ff2dec64b15d489b182.png
diff --git a/docs/_build/html/_images/blockdiag-114d74895afcb14b6c646878525148b8996ea20b.png b/docs/_build/html/_images/blockdiag-114d74895afcb14b6c646878525148b8996ea20b.png
diff --git a/docs/_build/html/_images/blockdiag-c13911bc522f6e33b9ebee5484f6dbe2b02f3204.png b/docs/_build/html/_images/blockdiag-c13911bc522f6e33b9ebee5484f6dbe2b02f3204.png
diff --git a/docs/_build/html/_images/blockdiag-ec2b8762c466c1b2f34ccd5497f593e6da8c7a52.png b/docs/_build/html/_images/blockdiag-ec2b8762c466c1b2f34ccd5497f593e6da8c7a52.png
diff --git a/docs/_build/html/_images/login_db.png b/docs/_build/html/_images/login_db.png
diff --git a/docs/_build/html/_modules/flask_appbuilder/actions.html b/docs/_build/html/_modules/flask_appbuilder/actions.html
@@ -0,0 +1,230 @@
+<!DOCTYPE html>
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+    <title>flask_appbuilder.actions &mdash; Flask AppBuilder</title>
+
+    <link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/bootswatch-3.3.6/flatly/bootstrap.min.css" type="text/css" />
+    <link rel="stylesheet" href="../../_static/bootstrap-sphinx.css" type="text/css" />
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../',
+        VERSION:     '1.6.1',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <script type="text/javascript" src="../../_static/js/jquery-1.11.0.min.js"></script>
+    <script type="text/javascript" src="../../_static/js/jquery-fix.js"></script>
+    <script type="text/javascript" src="../../_static/bootstrap-3.3.6/js/bootstrap.min.js"></script>
+    <script type="text/javascript" src="../../_static/bootstrap-sphinx.js"></script>
+    <link rel="top" title="Flask AppBuilder" href="../../index.html" />
+    <link rel="up" title="Module code" href="../index.html" />
+<meta charset='utf-8'>
+<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
+<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
+<meta name="apple-mobile-web-app-capable" content="yes">
+
+  </head>
+  <body role="document">
+
+  <a href="https://github.com/dpgaspar/Flask-AppBuilder"
+     class="visible-desktop hidden-xs"><img
+    id="gh-banner"
+    style="position: absolute; top: 50px; right: 0; border: 0;"
+    src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png"
+    alt="Fork me on GitHub"></a>
+  <script>
+    // Adjust banner height.
+    $(function () {
+      var navHeight = $(".navbar .container").css("height");
+      $("#gh-banner").css("top", navHeight);
+    });
+  </script>
+
+
+  <div id="navbar" class="navbar  navbar-default navbar-fixed-top">
+    <div class="container">
+      <div class="navbar-header">
+        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </button>
+        <a class="navbar-brand" href="../../index.html">
+          Flask-AppBuilder</a>
+        <span class="navbar-text navbar-version pull-left"><b>1.6.1</b></span>
+      </div>
+
+        <div class="collapse navbar-collapse nav-collapse">
+          <ul class="nav navbar-nav">
+
+                <li><a href="../../diagrams.html">Diagrams</a></li>
+
+
+              <li class="dropdown globaltoc-container">
+  <a role="button"
+     id="dLabelGlobalToc"
+     data-toggle="dropdown"
+     data-target="#"
+     href="../../index.html">Site <b class="caret"></b></a>
+  <ul class="dropdown-menu globaltoc"
+      role="menu"
+      aria-labelledby="dLabelGlobalToc"><ul>
+<li class="toctree-l1"><a class="reference internal" href="../../intro.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../fabmanager.html">Command Line Manager</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../config.html">Base Configuration</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../views.html">Base Views</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickhowto.html">Model Views (Quick How to)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickhowto_mongo.html">Model Views on MongoDB</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickcharts.html">Chart Views</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickfiles.html">Model Views with Files and Images</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../quickminimal.html">Quick Minimal Application</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../relations.html">Model Relations</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../actions.html">Actions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../advanced.html">Advanced Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../customizing.html">Customizing</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../templates.html">Templates</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../addons.html">AddOn development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../generic_datasource.html">Generic Data Sources</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../multipledbs.html">Multiple Databases</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../i18n.html">i18n Translations</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../security.html">Security</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../user_registration.html">User Registration</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../api.html">API Reference</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../versionmigration.html">Version Migration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../versions.html">Versions</a></li>
+</ul>
+</ul>
+</li>
+
+                <li class="dropdown">
+  <a role="button"
+     id="dLabelLocalToc"
+     data-toggle="dropdown"
+     data-target="#"
+     href="#">Page <b class="caret"></b></a>
+  <ul class="dropdown-menu localtoc"
+      role="menu"
+      aria-labelledby="dLabelLocalToc"></ul>
+</li>
+
+
+
+
+
+
+
+
+
+
+          </ul>
+
+
+
+<form class="navbar-form navbar-right" action="../../search.html" method="get">
+ <div class="form-group">
+  <input type="text" name="q" class="form-control" placeholder="Search" />
+ </div>
+  <input type="hidden" name="check_keywords" value="yes" />
+  <input type="hidden" name="area" value="default" />
+</form>
+
+        </div>
+    </div>
+  </div>
+
+<div class="container">
+  <div class="row">
+    <div class="col-md-12 content">
+
+  <h1>Source code for flask_appbuilder.actions</h1><div class="highlight"><pre>
+<span></span>
+<span class="k">class</span> <span class="nc">ActionItem</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+    <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+    <span class="n">text</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+    <span class="n">confirmation</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+    <span class="n">icon</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+    <span class="n">multiple</span> <span class="o">=</span> <span class="bp">True</span>
+    <span class="n">func</span> <span class="o">=</span> <span class="bp">None</span>
+
+    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">confirmation</span><span class="p">,</span> <span class="n">icon</span><span class="p">,</span> <span class="n">multiple</span><span class="p">,</span> <span class="n">single</span><span class="p">,</span> <span class="n">func</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">text</span> <span class="ow">or</span> <span class="n">name</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">confirmation</span> <span class="o">=</span> <span class="n">confirmation</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">icon</span> <span class="o">=</span> <span class="n">icon</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">multiple</span> <span class="o">=</span> <span class="n">multiple</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">single</span> <span class="o">=</span> <span class="n">single</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">func</span> <span class="o">=</span> <span class="n">func</span>
+
+    <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="s2">&quot;Action name:</span><span class="si">%s</span><span class="s2">; text:</span><span class="si">%s</span><span class="s2">; confirmation:</span><span class="si">%s</span><span class="s2">; func:</span><span class="si">%s</span><span class="s2">;&quot;</span> <span class="o">%</span> \
+                <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">text</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">confirmation</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">func</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
+
+
+<div class="viewcode-block" id="action"><a class="viewcode-back" href="../../api.html#flask.ext.appbuilder.actions.action">[docs]</a><span class="k">def</span> <span class="nf">action</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">confirmation</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">icon</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+            <span class="n">multiple</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">single</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Use this decorator to expose actions</span>
+
+<span class="sd">        :param name:</span>
+<span class="sd">            Action name</span>
+<span class="sd">        :param text:</span>
+<span class="sd">            Action text.</span>
+<span class="sd">        :param confirmation:</span>
+<span class="sd">            Confirmation text. If not provided, action will be executed</span>
+<span class="sd">            unconditionally.</span>
+<span class="sd">        :param icon:</span>
+<span class="sd">            Font Awesome icon name</span>
+<span class="sd">        :param multiple:</span>
+<span class="sd">            If true will display action on list view</span>
+<span class="sd">        :param single:</span>
+<span class="sd">            If true will display action on show view</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">def</span> <span class="nf">wrap</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
+        <span class="n">f</span><span class="o">.</span><span class="n">_action</span> <span class="o">=</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">confirmation</span><span class="p">,</span> <span class="n">icon</span><span class="p">,</span> <span class="n">multiple</span><span class="p">,</span> <span class="n">single</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">f</span>
+
+    <span class="k">return</span> <span class="n">wrap</span></div>
+</pre></div>
+
+    </div>
+
+  </div>
+</div>
+<footer class="footer">
+  <div class="container">
+    <p class="pull-right">
+      <a href="#">Back to top</a>
+
+    </p>
+    <p>
+        &copy; Copyright 2013, Daniel Vaz Gaspar.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.1.<br/>
+    </p>
+  </div>
+</footer>
+  </body>
+</html>