Skip to content

Commit

Permalink
docs and version update
Browse files Browse the repository at this point in the history
  • Loading branch information
dpgaspar committed Sep 28, 2015
1 parent 94c5791 commit 279677d
Show file tree
Hide file tree
Showing 36 changed files with 96 additions and 56 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Lots of `examples <https://github.com/dpgaspar/Flask-AppBuilder/tree/master/exam
Package Version
---------------

*New 1.4.6*.
*New 1.4.7*.

If you're already using F.A.B.
read carefully the `migration <http://flask-appbuilder.readthedocs.org/en/latest/versionmigration.html>`_ procedures.
Expand Down
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/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/versions.doctree
Binary file not shown.
3 changes: 2 additions & 1 deletion docs/_build/html/_sources/advanced.txt
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ Forms

This will filter list combo on Contact's model related with ContactGroup model.
The combo will be filtered with entries that start with W.
You can define individual filters for add and edit. Take a look at the :doc:`api`
You can define individual filters for add,edit and search using **add_form_quey_rel_fields**,
**edit_form_query_rel_fields**, **search_form_query_rel_fields** respectively. Take a look at the :doc:`api`
If you want to filter multiple related fields just add new keys to the dictionary,
remember you can add multiple filters for each field also, take a look at the *base_filter* property::

Expand Down
5 changes: 5 additions & 0 deletions docs/_build/html/_sources/versions.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Versions
========

Improvements and Bug fixes on 1.4.7
-----------------------------------

- New, #228 new property, search_form_query_rel_fields to filter combo lists on search related fields.

Improvements and Bug fixes on 1.4.6
-----------------------------------

Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/actions.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
7 changes: 4 additions & 3 deletions docs/_build/html/advanced.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -270,7 +270,8 @@ <h2>Forms<a class="headerlink" href="#forms" title="Permalink to this headline">
</ul>
<p>This will filter list combo on Contact&#8217;s model related with ContactGroup model.
The combo will be filtered with entries that start with W.
You can define individual filters for add and edit. Take a look at the <a class="reference internal" href="api.html"><em>API Reference</em></a>
You can define individual filters for add,edit and search using <strong>add_form_quey_rel_fields</strong>,
<strong>edit_form_query_rel_fields</strong>, <strong>search_form_query_rel_fields</strong> respectively. Take a look at the <a class="reference internal" href="api.html"><em>API Reference</em></a>
If you want to filter multiple related fields just add new keys to the dictionary,
remember you can add multiple filters for each field also, take a look at the <em>base_filter</em> property:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">ContactModelView</span><span class="p">(</span><span class="n">ModelView</span><span class="p">):</span>
Expand Down
20 changes: 18 additions & 2 deletions docs/_build/html/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -805,6 +805,22 @@ <h3>BaseModelView<a class="headerlink" href="#basemodelview" title="Permalink to
<p>search_form_extra_fields = {&#8216;some_col&#8217;:BooleanField(&#8216;Some Col&#8217;, default=False)}</p>
</dd></dl>

<dl class="attribute">
<dt id="flask.ext.appbuilder.baseviews.BaseModelView.search_form_query_rel_fields">
<code class="descname">search_form_query_rel_fields</code><em class="property"> = None</em><a class="headerlink" href="#flask.ext.appbuilder.baseviews.BaseModelView.search_form_query_rel_fields" title="Permalink to this definition"></a></dt>
<dd><p>Add Customized query for related fields on search form.
Assign a dictionary where the keys are the column names of
the related models to filter, the value for each key, is a list of lists with the
same format as base_filter
{&#8216;relation col name&#8217;:[[&#8216;Related model col&#8217;,FilterClass,&#8217;Filter Value&#8217;],...],...}
Add a custom filter to form related fields:</p>
<div class="highlight-python"><div class="highlight"><pre>class ContactModelView(ModelView):
datamodel = SQLAModel(Contact, db.session)
search_form_query_rel_fields = [(&#39;group&#39;:[[&#39;name&#39;,FilterStartsWith,&#39;W&#39;]]}
</pre></div>
</div>
</dd></dl>

<dl class="attribute">
<dt id="flask.ext.appbuilder.baseviews.BaseModelView.search_widget">
<code class="descname">search_widget</code><a class="headerlink" href="#flask.ext.appbuilder.baseviews.BaseModelView.search_widget" title="Permalink to this definition"></a></dt>
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/config.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/customizing.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/generic_datasource.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
12 changes: 8 additions & 4 deletions docs/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -64,7 +64,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -1102,6 +1102,10 @@ <h2 id="S">S</h2>
</dt>


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


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

Expand Down Expand Up @@ -1129,12 +1133,12 @@ <h2 id="S">S</h2>
<dt><a href="api.html#flask.ext.appbuilder.views.CompactCRUDMixin.set_key">set_key() (flask.ext.appbuilder.views.CompactCRUDMixin class method)</a>
</dt>

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

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

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

<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>
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/i18n.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -64,7 +64,7 @@
</button>
<a class="navbar-brand" href="#">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/multipledbs.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
Binary file modified docs/_build/html/objects.inv
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/_build/html/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -66,7 +66,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/quickcharts.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/quickfiles.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/quickhowto.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down
4 changes: 2 additions & 2 deletions docs/_build/html/quickminimal.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.6',
VERSION: '1.4.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
Expand Down Expand Up @@ -65,7 +65,7 @@
</button>
<a class="navbar-brand" href="index.html">
Flask-AppBuilder</a>
<span class="navbar-text navbar-version pull-left"><b>1.4.6</b></span>
<span class="navbar-text navbar-version pull-left"><b>1.4.7</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down

0 comments on commit 279677d

Please sign in to comment.