Docs for 0.8.4

This commit is contained in:
Maxime Beauchemin
2016-03-24 08:12:39 -07:00
parent df82e3c85b
commit f4f614d76b
9 changed files with 29 additions and 16 deletions

1
.gitignore vendored
View File

@@ -1,4 +1,5 @@
*.pyc
panoramix
babel
.DS_Store
.coverage

View File

@@ -13,9 +13,9 @@ Features
providers (database, OpenID, LDAP, OAuth & REMOTE_USER through
Flask AppBuilder)
- A simple semantic layer, allowing users to control how data sources are
displayed in the UI by defining which fields should show up in which
drop-down and which aggregation and function metrics are made available
to the user
displayed in the UI by defining which fields should show up in which
drop-down and which aggregation and function metrics are made available
to the user
- Integration with most RDBMS through SqlAlchemy
- Deep integration with Druid.io
@@ -25,10 +25,10 @@ Contents
.. toctree::
:maxdepth: 2
installation
user_guide
Indices and tables
------------------

View File

@@ -9,7 +9,7 @@ Quick Intro
This video demonstrates how Dashed works at a high level, it shows how
to navigate through datasets and dashboards that are already available.
- Coming soon!
.. youtube:: https://www.youtube.com/watch?v=3Txm_nj_R7M
Dashboard Creation
''''''''''''''''''

View File

@@ -67,6 +67,7 @@
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation &amp; Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
</ul>
</ul>

1
get-docs.sh Executable file
View File

@@ -0,0 +1 @@
cp -r /tmp/dashed-docs/* .

View File

@@ -31,7 +31,7 @@
<script type="text/javascript" src="_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<link rel="top" title="dashed documentation" href="#" />
<link rel="next" title="User Guide" href="user_guide.html" />
<link rel="next" title="Installation &amp; Configuration" href="installation.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'>
@@ -67,6 +67,7 @@
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation &amp; Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
</ul>
</ul>
@@ -96,7 +97,7 @@
<li>
<a href="user_guide.html" title="Next Chapter: User Guide"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">User Guide &raquo;</span>
<a href="installation.html" title="Next Chapter: Installation & Configuration"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Installation ... &raquo;</span>
</a>
</li>
@@ -235,10 +236,13 @@ Flask AppBuilder)</p>
</dd>
</dl>
</li>
<li><p class="first">A simple semantic layer, allowing users to control how data sources are
displayed in the UI by defining which fields should show up in which
<li><dl class="first docutils">
<dt>A simple semantic layer, allowing users to control how data sources are</dt>
<dd><p class="first last">displayed in the UI by defining which fields should show up in which
drop-down and which aggregation and function metrics are made available
to the user</p>
</dd>
</dl>
</li>
<li><p class="first">Integration with most RDBMS through SqlAlchemy</p>
</li>
@@ -250,6 +254,13 @@ to the user</p>
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation &amp; Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#getting-started">Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#caching">Caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#druid">Druid</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#quick-intro">Quick Intro</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#dashboard-creation">Dashboard Creation</a></li>

View File

@@ -74,6 +74,7 @@
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation &amp; Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
</ul>
</ul>

View File

@@ -1 +1 @@
Search.setIndex({envversion:46,filenames:["index","user_guide"],objects:{},objnames:{},objtypes:{},terms:{"function":0,"new":1,"short":1,access:[0,1],affect:1,aggreg:0,allow:0,alreadi:1,alter:1,annot:0,appbuild:0,appli:1,aspect:1,authent:0,avail:[0,1],best:0,can:[0,1],certain:1,chart:1,collect:1,come:1,control:0,creat:[0,1],creation:0,css:0,custom:0,dash:1,dashboard:0,data:[0,1],databas:0,dataset:[0,1],deep:0,defin:0,demonstr:1,deriv:1,differ:1,dimens:1,displai:0,down:0,drop:0,druid:0,dynam:1,enterpris:0,exist:1,explor:1,expos:1,express:0,extens:0,field:0,filter:0,flask:0,from:[0,1],granular:0,guid:0,high:[0,1],how:[0,1],immun:1,index:0,individu:0,integr:0,intric:0,intro:0,languag:1,layer:0,ldap:0,level:1,librari:0,made:0,major:0,markdown:1,metric:[0,1],model:0,modul:0,most:0,navig:1,oauth:0,openid:0,other:1,own:1,page:0,permiss:0,provid:0,quick:0,rdbm:0,readi:0,remote_us:0,rich:0,rule:0,search:0,secur:0,semant:[0,1],set:0,share:0,should:0,show:[0,1],simpl:[0,1],slice:0,some:0,soon:1,sourc:0,sql:0,sqlalchemi:0,templat:1,them:1,theme:0,thi:1,through:[0,1],toggl:1,user:0,video:1,view:1,visual:0,walk:1,walkthrough:1,which:0,who:0,widget:1,work:1,you:1,your:1},titles:["Overview","User Guide"],titleterms:{annot:1,content:0,creation:1,css:1,custom:1,dashboard:1,defin:1,express:1,featur:0,filter:1,guid:1,indic:0,intro:1,overview:0,quick:1,slice:1,sql:1,tabl:[0,1],theme:1,user:1}})
Search.setIndex({envversion:46,filenames:["index","installation","user_guide"],objects:{},objnames:{},objtypes:{},terms:{"1thisismyscretkei":1,"default":1,"function":0,"new":2,"short":2,"true":1,"while":1,abl:1,about:1,access:[0,2],account:1,action:1,admin:1,affect:2,after:1,aggreg:0,all:1,allow:[0,1],alreadi:2,also:1,alter:2,annot:0,app:1,appbuild:0,appli:2,applic:1,aspect:2,authent:0,avail:[0,2],awar:1,back:1,backend:1,best:0,bring:1,browser:1,builder:1,cach:0,cache_config:1,can:[0,1,2],certain:2,chart:2,cluster:1,collect:2,come:2,compli:1,config:1,configur:0,connect:1,constant:1,consult:1,control:0,copi:1,creat:[0,1,2],creation:0,credenti:1,csrf:1,csrf_enabl:1,css:0,current:1,custom:0,dash:2,dashboard:0,data:[0,1,2],databas:[0,1],dataset:[0,2],datasourc:1,debug:1,deep:0,defin:[0,1],demonstr:2,deriv:2,develop:1,differ:2,dimens:2,displai:0,document:1,done:1,down:0,drop:0,druid:0,dynam:2,easi:1,enter:1,enterpris:0,exist:2,explor:2,expos:2,express:0,extens:0,fabmanag:1,fall:1,few:1,field:0,file:1,filesystem:1,filter:0,flag:1,flask:[0,1],follow:1,framework:1,from:[0,1,2],get:0,global:1,goe:1,granular:0,guid:0,here:1,high:[0,2],hit:1,hostnam:1,how:[0,1,2],http:1,immun:2,index:0,individu:0,inform:1,init:1,initi:1,instal:0,integr:0,intric:0,intro:0,item:1,kei:1,languag:2,layer:0,ldap:0,level:2,librari:0,load:1,load_exampl:1,local:1,localhost:1,login:1,made:0,major:0,make:1,markdown:2,memcach:1,memori:1,menu:1,metadata:1,metric:[0,2],mode:1,model:0,modul:[0,1],more:1,most:0,multipl:1,navig:[1,2],need:1,oauth:0,onc:1,onli:1,openid:0,other:2,own:2,page:0,panoramix:1,panoramix_config:1,panoramix_webserver_port:1,paramet:1,past:1,permiss:[0,1],pip:1,plai:1,pleas:1,point:1,popul:1,port:1,provid:[0,1],purpos:1,python:1,pythonpath:1,quick:0,rdbm:0,readi:0,redi:1,refresh:1,remote_us:0,rich:0,right:1,roadmap:1,role:1,row_limit:1,rule:0,run:1,runserv:1,search:0,searchpath:1,secret:1,secret_kei:1,secur:0,semant:[0,2],server:1,set:[0,1],share:0,should:[0,1],show:[0,1,2],sign:1,simpl:[0,1,2],simplecach:1,slice:[0,1],some:[0,1],soon:2,sourc:[0,1],specif:1,specifix:1,sql:0,sqlalchemi:[0,1],sqlalchemy_database_uri:1,sqlite:1,start:0,step:1,string:1,support:1,sure:1,templat:2,test:1,thei:1,them:2,theme:0,thi:[1,2],through:[0,2],timeout:1,tmp:1,toggl:2,ultim:1,upgrad:1,user:[0,1],video:2,view:2,visual:0,walk:2,walkthrough:2,web:1,webserver_thread:1,where:1,whether:1,which:0,who:0,widget:2,won:1,work:2,wtf:1,you:[1,2],your:[1,2]},titles:["Overview","Installation &amp; Configuration","User Guide"],titleterms:{annot:2,cach:1,configur:1,content:0,creation:2,css:2,custom:2,dashboard:2,defin:2,druid:1,express:2,featur:0,filter:2,get:1,guid:2,indic:0,instal:1,intro:2,overview:0,quick:2,slice:2,sql:2,start:1,tabl:[0,2],theme:2,user:2}})

View File

@@ -31,7 +31,7 @@
<script type="text/javascript" src="_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<link rel="top" title="dashed documentation" href="index.html" />
<link rel="prev" title="Overview" href="index.html" />
<link rel="prev" title="Installation &amp; Configuration" href="installation.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'>
@@ -67,6 +67,7 @@
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation &amp; Configuration</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">User Guide</a></li>
</ul>
</ul>
@@ -100,7 +101,7 @@
<li>
<a href="index.html" title="Previous Chapter: Overview"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Overview</span>
<a href="installation.html" title="Previous Chapter: Installation & Configuration"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Installation ...</span>
</a>
</li>
@@ -137,10 +138,7 @@ of Dashed.</p>
<h2>Quick Intro<a class="headerlink" href="#quick-intro" title="Permalink to this headline"></a></h2>
<p>This video demonstrates how Dashed works at a high level, it shows how
to navigate through datasets and dashboards that are already available.</p>
<ul class="simple">
<li>Coming soon!</li>
</ul>
</div>
<iframe width="640" height="360" src="//www.youtube.com/embed/3Txm_nj_R7M?feature=player_detailpage" frameborder="0" allowfullscreen="1">&nbsp;</iframe></div>
<div class="section" id="dashboard-creation">
<h2>Dashboard Creation<a class="headerlink" href="#dashboard-creation" title="Permalink to this headline"></a></h2>
<p>This video walk you through the creation of a simple dashboard as a