Skip to content

Commit

Permalink
class diagrams on docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dpgaspar committed Mar 18, 2015
1 parent d5ecc66 commit 16243fd
Show file tree
Hide file tree
Showing 118 changed files with 356 additions and 605 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/multipledbs.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/quickminimal.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: 7cec41a8fa34fdb221a3de81b07410c3
config: c09b3a18a167e2aa75e269e22bd7314d
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file modified docs/_build/html/_images/Charts.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/ListThumbnail.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/Login_db.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/chart.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/chart_time1.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/chart_time2.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/charts.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/contact_list.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/contacts.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/direct_chart.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/fab.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/group_list.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/grouped_chart.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/groups.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/images_list.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/list_cascade.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/list_cascade_block.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/list_compact_inline.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/list_master_detail.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/login.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/login_db.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/login_oid.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/security.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_images/simpleview2.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_sources/actions.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/advanced.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/api.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/config.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/customizing.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/generic_datasource.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/i18n.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/images/templates.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/index.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/installation.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/intro.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/multipledbs.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/quickcharts.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/quickfiles.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/quickhowto.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/quickminimal.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/relations.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/security.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/templates.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/versionmigration.txt
100644 → 100755
Empty file.
Empty file modified docs/_build/html/_sources/versions.txt
100644 → 100755
Empty file.
22 changes: 0 additions & 22 deletions docs/_build/html/_sources/views.txt
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,6 @@ Additionally you can have granular security (method access security) that can be
The views documented on this chapter are the building blocks of F.A.B, but the juicy part is on the next chapter
with ModelView, ChartView and others.

Class View Diagram Tree
-----------------------

All class views tree reflect functionality each layer is responsible for a certain goal. You will be essentially using
BaseViews, IndexViews and the leafs ModelView, chart views and form views.

.. image:: ./images/fab_object_view_diag.png
:width: 100%

Next is a summary explanation of each class:

:BaseView: Collects all the exposed methods, creates the Flask blueprint and registers the URLs, initializes base permissions.
:UtilView: Implements exposes **back** for special back UI functionality.
:IndexView: Special view for rendering the index page.
:SimpleFormView: Subclass it to render WTForms.
:PublicFormView: Same as SimpleFormView but with public access only.
:BaseModelView: Class responsible for an initial datamodel layer, implements search form and filters.
:BaseChartView: Basic chart view functionality.
:GroupByChartView: Subclass it to render Google charts with group by queries.



BaseView
--------

Expand Down
Empty file modified docs/_build/html/_static/Flask-AppBuilder.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/_build/html/_static/ajax-loader.gif
100644 → 100755
74 changes: 6 additions & 68 deletions docs/_build/html/_static/basic.css
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -197,10 +197,7 @@ h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
dt:hover > a.headerlink {
visibility: visible;
}

Expand Down Expand Up @@ -317,13 +314,6 @@ table.docutils {
border-collapse: collapse;
}

table caption span.caption-number {
font-style: italic;
}

table caption span.caption-text {
}

table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
Expand Down Expand Up @@ -354,25 +344,6 @@ table.citation td {
border-bottom: none;
}

/* -- figures --------------------------------------------------------------- */

div.figure {
margin: 0.5em;
padding: 0.5em;
}

div.figure p.caption {
padding: 0.3em;
}

div.figure p.caption span.caption-number {
font-style: italic;
}

div.figure p.caption span.caption-text {
}


/* -- other body styles ----------------------------------------------------- */

ol.arabic {
Expand Down Expand Up @@ -435,10 +406,6 @@ dl.glossary dt {
font-size: 1.3em;
}

.sig-paren {
font-size: larger;
}

.versionmodified {
font-style: italic;
}
Expand Down Expand Up @@ -504,51 +471,22 @@ table.highlighttable td {
padding: 0 0.5em 0 0.5em;
}

div.code-block-caption {
padding: 2px 5px;
font-size: small;
}

div.code-block-caption code {
background-color: transparent;
}

div.code-block-caption + div > div.highlight > pre {
margin-top: 0;
}

div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
}

div.code-block-caption span.caption-text {
}

div.literal-block-wrapper {
padding: 1em 1em 0;
}

div.literal-block-wrapper div.highlight {
margin: 0;
}

code.descname {
tt.descname {
background-color: transparent;
font-weight: bold;
font-size: 1.2em;
}

code.descclassname {
tt.descclassname {
background-color: transparent;
}

code.xref, a code {
tt.xref, a tt {
background-color: transparent;
font-weight: bold;
}

h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
background-color: transparent;
}

Expand Down
Empty file modified docs/_build/html/_static/comment-bright.png
100644 → 100755
Empty file modified docs/_build/html/_static/comment-close.png
100644 → 100755
Empty file modified docs/_build/html/_static/comment.png
100644 → 100755
29 changes: 2 additions & 27 deletions docs/_build/html/_static/doctools.js
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -91,30 +91,6 @@ jQuery.fn.highlightText = function(text, className) {
});
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}

/**
* Small JavaScript module for the documentation.
*/
Expand Down Expand Up @@ -176,10 +152,9 @@ var Documentation = {

/**
* workaround a firefox stupidity
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash)
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
Expand Down
Binary file modified docs/_build/html/_static/down-pressed.png
100644 → 100755
Binary file modified docs/_build/html/_static/down.png
100644 → 100755
Binary file modified docs/_build/html/_static/file.png
100644 → 100755
Empty file modified docs/_build/html/_static/flasky.css
100644 → 100755
Empty file.
6 changes: 2 additions & 4 deletions docs/_build/html/_static/jquery.js
100644 → 100755

Large diffs are not rendered by default.

Binary file modified docs/_build/html/_static/minus.png
100644 → 100755
Binary file modified docs/_build/html/_static/plus.png
100644 → 100755
Empty file modified docs/_build/html/_static/pygments.css
100644 → 100755
Empty file.
4 changes: 2 additions & 2 deletions docs/_build/html/_static/searchtools.js
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilties for the full-text search.
*
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -439,7 +439,7 @@ var Search = {
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
if (data !== '' && data !== undefined) {
if (data !== '') {
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
}
Search.output.append(listItem);
Expand Down
Empty file modified docs/_build/html/_static/underscore.js
100644 → 100755
Empty file.
Binary file modified docs/_build/html/_static/up-pressed.png
100644 → 100755
Binary file modified docs/_build/html/_static/up.png
100644 → 100755
30 changes: 15 additions & 15 deletions docs/_build/html/_static/websupport.js
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* sphinx.websupport utilties for all documentation.
*
* :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -50,51 +50,51 @@
}

function initEvents() {
$(document).on("click", 'a.comment-close', function(event) {
$('a.comment-close').live("click", function(event) {
event.preventDefault();
hide($(this).attr('id').substring(2));
});
$(document).on("click", 'a.vote', function(event) {
$('a.vote').live("click", function(event) {
event.preventDefault();
handleVote($(this));
});
$(document).on("click", 'a.reply', function(event) {
$('a.reply').live("click", function(event) {
event.preventDefault();
openReply($(this).attr('id').substring(2));
});
$(document).on("click", 'a.close-reply', function(event) {
$('a.close-reply').live("click", function(event) {
event.preventDefault();
closeReply($(this).attr('id').substring(2));
});
$(document).on("click", 'a.sort-option', function(event) {
$('a.sort-option').live("click", function(event) {
event.preventDefault();
handleReSort($(this));
});
$(document).on("click", 'a.show-proposal', function(event) {
$('a.show-proposal').live("click", function(event) {
event.preventDefault();
showProposal($(this).attr('id').substring(2));
});
$(document).on("click", 'a.hide-proposal', function(event) {
$('a.hide-proposal').live("click", function(event) {
event.preventDefault();
hideProposal($(this).attr('id').substring(2));
});
$(document).on("click", 'a.show-propose-change', function(event) {
$('a.show-propose-change').live("click", function(event) {
event.preventDefault();
showProposeChange($(this).attr('id').substring(2));
});
$(document).on("click", 'a.hide-propose-change', function(event) {
$('a.hide-propose-change').live("click", function(event) {
event.preventDefault();
hideProposeChange($(this).attr('id').substring(2));
});
$(document).on("click", 'a.accept-comment', function(event) {
$('a.accept-comment').live("click", function(event) {
event.preventDefault();
acceptComment($(this).attr('id').substring(2));
});
$(document).on("click", 'a.delete-comment', function(event) {
$('a.delete-comment').live("click", function(event) {
event.preventDefault();
deleteComment($(this).attr('id').substring(2));
});
$(document).on("click", 'a.comment-markup', function(event) {
$('a.comment-markup').live("click", function(event) {
event.preventDefault();
toggleCommentMarkupBox($(this).attr('id').substring(2));
});
Expand Down Expand Up @@ -700,8 +700,8 @@
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
<div class="comment-markup-box" id="mb<%id%>">\
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
<code>``code``</code>, \
code blocks: <code>::</code> and an indented block after blank line</div>\
<tt>``code``</tt>, \
code blocks: <tt>::</tt> and an indented block after blank line</div>\
<form method="post" id="cf<%id%>" class="comment-form" action="">\
<textarea name="comment" cols="80"></textarea>\
<p class="propose-button">\
Expand Down
12 changes: 4 additions & 8 deletions docs/_build/html/actions.html
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<meta name="apple-mobile-web-app-capable" content="yes">

</head>
<body role="document">
<body>

<a href="https://github.com/dpgaspar/Flask-AppBuilder"
class="visible-desktop hidden-xs"><img
Expand Down Expand Up @@ -71,6 +71,8 @@
<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"
Expand Down Expand Up @@ -152,12 +154,6 @@



<li class="hidden-sm">
<div id="sourcelink">
<a href="_sources/actions.txt"
rel="nofollow">Source</a>
</div></li>

</ul>


Expand Down Expand Up @@ -245,7 +241,7 @@ <h2>Define your view<a class="headerlink" href="#define-your-view" title="Permal
</p>
<p>
&copy; Copyright 2013, Daniel Vaz Gaspar.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2.3.<br/>
</p>
</div>
</footer>
Expand Down
12 changes: 4 additions & 8 deletions docs/_build/html/advanced.html
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<meta name="apple-mobile-web-app-capable" content="yes">

</head>
<body role="document">
<body>

<a href="https://github.com/dpgaspar/Flask-AppBuilder"
class="visible-desktop hidden-xs"><img
Expand Down Expand Up @@ -71,6 +71,8 @@
<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"
Expand Down Expand Up @@ -156,12 +158,6 @@



<li class="hidden-sm">
<div id="sourcelink">
<a href="_sources/advanced.txt"
rel="nofollow">Source</a>
</div></li>

</ul>


Expand Down Expand Up @@ -350,7 +346,7 @@ <h2>Forms<a class="headerlink" href="#forms" title="Permalink to this headline">
</p>
<p>
&copy; Copyright 2013, Daniel Vaz Gaspar.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2.3.<br/>
</p>
</div>
</footer>
Expand Down
Loading

0 comments on commit 16243fd

Please sign in to comment.