Skip to content

Commit

Permalink
docs fork me on git ribbon
Browse files Browse the repository at this point in the history
  • Loading branch information
dpgaspar committed Feb 6, 2015
1 parent ce8133b commit 0a583b2
Show file tree
Hide file tree
Showing 49 changed files with 478 additions and 16 deletions.
Binary file modified docs/_build/doctrees/actions.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/advanced.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/api.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/config.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/customizing.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/generic_datasource.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/i18n.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/installation.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/intro.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/quickcharts.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/quickfiles.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/quickhowto.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/relations.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/security.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/templates.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/versionmigration.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/versions.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/views.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: 3d3aca0ff9764a8ca1207d1a2e671bb0
config: 9d3b59a3aafdc74a296fd540fa79c15d
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ BaseSecurityManager
BaseRegisterUser
----------------

.. automodule:: flask.ext.appbuilder.security.registerviews
.. automodule:: flask.ext.appbuilder.security.sqla.registerviews

.. autoclass:: BaseRegisterUser
:members:
Expand Down
15 changes: 15 additions & 0 deletions docs/_build/html/actions.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@

</head>
<body>

<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">
Expand Down
15 changes: 15 additions & 0 deletions docs/_build/html/advanced.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@

</head>
<body>

<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">
Expand Down
86 changes: 83 additions & 3 deletions docs/_build/html/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@

</head>
<body>

<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">
Expand Down Expand Up @@ -136,7 +151,7 @@
<li><a class="reference internal" href="#module-flask.ext.appbuilder.actions">flask.ext.appbuilder.actions</a></li>
<li><a class="reference internal" href="#module-flask.ext.appbuilder.security.manager">flask.ext.appbuilder.security</a><ul>
<li><a class="reference internal" href="#basesecuritymanager">BaseSecurityManager</a></li>
<li><a class="reference internal" href="#baseregisteruser">BaseRegisterUser</a></li>
<li><a class="reference internal" href="#module-flask.ext.appbuilder.security.sqla.registerviews">BaseRegisterUser</a></li>
</ul>
</li>
<li><a class="reference internal" href="#module-flask.ext.appbuilder.filemanager">flask.ext.appbuilder.filemanager</a></li>
Expand Down Expand Up @@ -1734,8 +1749,73 @@ <h3>BaseSecurityManager<a class="headerlink" href="#basesecuritymanager" title="

</div></blockquote>
</div>
<div class="section" id="baseregisteruser">
<h3>BaseRegisterUser<a class="headerlink" href="#baseregisteruser" title="Permalink to this headline"></a></h3>
<div class="section" id="module-flask.ext.appbuilder.security.sqla.registerviews">
<span id="baseregisteruser"></span><h3>BaseRegisterUser<a class="headerlink" href="#module-flask.ext.appbuilder.security.sqla.registerviews" title="Permalink to this headline"></a></h3>
<dl class="class">
<dt id="flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser">
<em class="property">class </em><tt class="descclassname">flask.ext.appbuilder.security.sqla.registerviews.</tt><tt class="descname">BaseRegisterUser</tt><a class="reference internal" href="_modules/flask/ext/appbuilder/security/sqla/registerviews.html#BaseRegisterUser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser" title="Permalink to this definition"></a></dt>
<dd><p>Make your own user registration view and inherit from this class if you
want to implement a completely different registration process. If not,
just inherit from RegisterUserDBView or RegisterUserOIDView depending on
your authentication method.
then override SecurityManager property that defines the class to use:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">flask.ext.appbuilder.security.registerviews</span> <span class="kn">import</span> <span class="n">RegisterUserDBView</span>

<span class="k">class</span> <span class="nc">MyRegisterUserDBView</span><span class="p">(</span><span class="n">BaseRegisterUser</span><span class="p">):</span>
<span class="n">email_template</span> <span class="o">=</span> <span class="s">&#39;register_mail.html&#39;</span>
<span class="o">...</span>


<span class="k">class</span> <span class="nc">MySecurityManager</span><span class="p">(</span><span class="n">SecurityManager</span><span class="p">):</span>
<span class="n">registeruserdbview</span> <span class="o">=</span> <span class="n">MyRegisterUserDBView</span>
</pre></div>
</div>
<p>When instantiating AppBuilder set your own SecurityManager class:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">appbuilder</span> <span class="o">=</span> <span class="n">AppBuilder</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">db</span><span class="o">.</span><span class="n">session</span><span class="p">,</span> <span class="n">security_manager_class</span><span class="o">=</span><span class="n">MySecurityManager</span><span class="p">)</span>
</pre></div>
</div>
<dl class="method">
<dt id="flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.activation">
<tt class="descname">activation</tt><big>(</big><em>activation_hash</em><big>)</big><a class="reference internal" href="_modules/flask/ext/appbuilder/security/sqla/registerviews.html#BaseRegisterUser.activation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.activation" title="Permalink to this definition"></a></dt>
<dd><p>Endpoint to expose an activation url, this url
is sent to the user by email, when accessed the user is inserted
and activated</p>
</dd></dl>

<dl class="attribute">
<dt id="flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.activation_template">
<tt class="descname">activation_template</tt><em class="property"> = 'appbuilder/general/security/activation.html'</em><a class="headerlink" href="#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.activation_template" title="Permalink to this definition"></a></dt>
<dd><p>The activation template, shown when the user is activated</p>
</dd></dl>

<dl class="method">
<dt id="flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.add_registration">
<tt class="descname">add_registration</tt><big>(</big><em>username</em>, <em>first_name</em>, <em>last_name</em>, <em>email</em>, <em>password=''</em><big>)</big><a class="reference internal" href="_modules/flask/ext/appbuilder/security/sqla/registerviews.html#BaseRegisterUser.add_registration"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.add_registration" title="Permalink to this definition"></a></dt>
<dd><blockquote>
<div>Add a registration request for the user.</div></blockquote>
<p>:rtype : RegisterUser</p>
</dd></dl>

<dl class="attribute">
<dt id="flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.email_subject">
<tt class="descname">email_subject</tt><em class="property"> = l'Account activation'</em><a class="headerlink" href="#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.email_subject" title="Permalink to this definition"></a></dt>
<dd><p>The email subject sent to the user</p>
</dd></dl>

<dl class="attribute">
<dt id="flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.email_template">
<tt class="descname">email_template</tt><em class="property"> = 'appbuilder/general/security/register_mail.html'</em><a class="headerlink" href="#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.email_template" title="Permalink to this definition"></a></dt>
<dd><p>The template used to generate the email sent to the user</p>
</dd></dl>

<dl class="method">
<dt id="flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.send_email">
<tt class="descname">send_email</tt><big>(</big><em>register_user</em><big>)</big><a class="reference internal" href="_modules/flask/ext/appbuilder/security/sqla/registerviews.html#BaseRegisterUser.send_email"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.send_email" title="Permalink to this definition"></a></dt>
<dd><p>Method for sending the registration Email to the user</p>
</dd></dl>

</dd></dl>

</div>
</div>
<div class="section" id="module-flask.ext.appbuilder.filemanager">
Expand Down
15 changes: 15 additions & 0 deletions docs/_build/html/config.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@

</head>
<body>

<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">
Expand Down
17 changes: 16 additions & 1 deletion docs/_build/html/customizing.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@

</head>
<body>

<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">
Expand Down Expand Up @@ -209,7 +224,7 @@ <h2>Changing the index<a class="headerlink" href="#changing-the-index" title="Pe
<p>What happened here? We should always extend from &#8220;appbuilder/base.html&#8221; this is the base template that will include all CSS&#8217;s, Javascripts, and construct the menu based on the user&#8217;s security definition.</p>
<p>Next we will override the &#8220;content&#8221; block, we could override other areas like CSS, extend CSS, Javascript or extend javascript. We can even override the base.html completely</p>
<p>I&#8217;ve presented the text on the content like:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{{</span><span class="n">_</span><span class="p">(</span><span class="s">&quot;text to be translated&quot;</span><span class="p">)}}</span>
<div class="highlight-python"><div class="highlight"><pre>{{_(&quot;text to be translated&quot;)}}
</pre></div>
</div>
<p>So that we can use Babel to translate our index text</p>
Expand Down
15 changes: 15 additions & 0 deletions docs/_build/html/generic_datasource.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,21 @@

</head>
<body>

<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">
Expand Down
63 changes: 55 additions & 8 deletions docs/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,21 @@

</head>
<body>

<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">
Expand Down Expand Up @@ -199,6 +214,14 @@ <h2 id="A">A</h2>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.activation">activation() (flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser method)</a>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.activation_template">activation_template (flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser attribute)</a>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.add_columns">add_columns (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>, <a href="quickhowto.html#flask.ext.appbuilder.baseviews.BaseCRUDView.add_columns">[1]</a>
</dt>

Expand Down Expand Up @@ -247,6 +270,10 @@ <h2 id="A">A</h2>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.add_registration">add_registration() (flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser method)</a>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.base.AppBuilder.add_separator">add_separator() (flask.ext.appbuilder.base.AppBuilder method)</a>
</dt>

Expand All @@ -266,6 +293,8 @@ <h2 id="A">A</h2>
<dt><a href="api.html#flask.ext.appbuilder.base.AppBuilder.add_view">add_view() (flask.ext.appbuilder.base.AppBuilder method)</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="api.html#flask.ext.appbuilder.security.manager.BaseSecurityManager.add_view_menu">add_view_menu() (flask.ext.appbuilder.security.manager.BaseSecurityManager method)</a>
</dt>
Expand All @@ -274,8 +303,6 @@ <h2 id="A">A</h2>
<dt><a href="api.html#flask.ext.appbuilder.base.AppBuilder.add_view_no_menu">add_view_no_menu() (flask.ext.appbuilder.base.AppBuilder method)</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.add_widget">add_widget (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>
</dt>
Expand Down Expand Up @@ -393,6 +420,10 @@ <h2 id="B">B</h2>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser">BaseRegisterUser (class in flask.ext.appbuilder.security.sqla.registerviews)</a>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.security.manager.BaseSecurityManager">BaseSecurityManager (class in flask.ext.appbuilder.security.manager)</a>
</dt>

Expand Down Expand Up @@ -532,12 +563,12 @@ <h2 id="E">E</h2>
<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.edit_form_query_rel_fields">edit_form_query_rel_fields (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.edit_template">edit_template (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.edit_title">edit_title (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>
</dt>
Expand All @@ -557,6 +588,14 @@ <h2 id="E">E</h2>

</dl></dd>

<dt><a href="api.html#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.email_subject">email_subject (flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser attribute)</a>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.email_template">email_template (flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser attribute)</a>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.baseviews.expose">expose() (in module flask.ext.appbuilder.baseviews)</a>, <a href="views.html#flask.ext.appbuilder.baseviews.expose">[1]</a>
</dt>

Expand Down Expand Up @@ -618,12 +657,12 @@ <h2 id="F">F</h2>
<dt><a href="api.html#module-flask.ext.appbuilder.filemanager">flask.ext.appbuilder.filemanager (module)</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="api.html#module-flask.ext.appbuilder.models.generic">flask.ext.appbuilder.models.generic (module)</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="api.html#module-flask.ext.appbuilder.models.group">flask.ext.appbuilder.models.group (module)</a>
</dt>
Expand All @@ -641,6 +680,10 @@ <h2 id="F">F</h2>
</dt>


<dt><a href="api.html#module-flask.ext.appbuilder.security.sqla.registerviews">flask.ext.appbuilder.security.sqla.registerviews (module)</a>
</dt>


<dt><a href="api.html#module-flask.ext.appbuilder.views">flask.ext.appbuilder.views (module)</a>
</dt>

Expand Down Expand Up @@ -1013,16 +1056,20 @@ <h2 id="S">S</h2>

</dl></dd>

<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.show_columns">show_columns (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>, <a href="quickhowto.html#flask.ext.appbuilder.baseviews.BaseCRUDView.show_columns">[1]</a>
<dt><a href="api.html#flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser.send_email">send_email() (flask.ext.appbuilder.security.sqla.registerviews.BaseRegisterUser method)</a>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.show_fieldsets">show_fieldsets (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>
<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.show_columns">show_columns (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>, <a href="quickhowto.html#flask.ext.appbuilder.baseviews.BaseCRUDView.show_columns">[1]</a>
</dt>

</dl></td>
<td style="width: 33%" valign="top"><dl>

<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.show_fieldsets">show_fieldsets (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>
</dt>


<dt><a href="api.html#flask.ext.appbuilder.baseviews.BaseCRUDView.show_template">show_template (flask.ext.appbuilder.baseviews.BaseCRUDView attribute)</a>
</dt>

Expand Down
Loading

0 comments on commit 0a583b2

Please sign in to comment.