Working on docs

README.md

@@ -11,7 +11,7 @@ and interactive.
 
 Panoramix
 ---------
-Panoramix's main goal is to make it easy to slice, dice and visualize data. 
+Panoramix's main goal is to make it easy to slice, dice and visualize data.
 It empowers its user to perform **analytics at the speed of thought**.
 
 Panoramix provides:

docs/_static/docs.css

@@ -0,0 +1,42 @@
+body {
+    padding-top: 0px;
+}
+
+div.navbar {
+    margin-bottom: 0px;
+}
+
+.carousel img {
+  max-height: 500px;
+}
+.carousel {
+  overflow: hidden;
+  height: 500px;
+}
+.carousel-caption h1 {
+  font-size: 80px;
+}
+.carousel-caption p {
+  font-size: 20px;
+}
+div.carousel-caption{
+  background: rgba(0,0,0,0.5);
+  border-radius: 20px;
+  top: 150px;
+  bottom: auto !important;
+}
+.carousel-inner > .item > img {
+  margin: 0 auto;
+}
+{
+  margin: -20px;
+}
+.carousel-indicators li {
+  background-color: #AAA;
+  border: 1px solid black;
+}
+
+.carousel-indicators .active {
+  background-color: #000;
+  border: 5px solid black;
+}

docs/_templates/layout.html

@@ -0,0 +1,95 @@
+{% extends "!layout.html" %}
+
+{% set bootswatch_css_custom = ['_static/docs.css'] %}
+
+{%- block content %}
+  {{ navBar() }}
+  {% if pagename == 'index' %}
+    <div id="carousel" class="carousel slide" data-ride="carousel">
+      <!-- Indicators -->
+      <ol class="carousel-indicators">
+        <li data-target="#carousel" data-slide-to="0" class="active"></li>
+        <li data-target="#carousel" data-slide-to="1"></li>
+        <li data-target="#carousel" data-slide-to="2"></li>
+        <li data-target="#carousel" data-slide-to="3"></li>
+        <li data-target="#carousel" data-slide-to="4"></li>
+      </ol>
+
+      <!-- Wrapper for slides -->
+      <div class="carousel-inner" role="listbox">
+        <div class="item active text-center">
+          <img src="/static/img/dash.png">
+          <div class="carousel-caption">
+            <div>
+              <h1>Panoramix</h1>
+              <p>
+                an open source data visualization platform
+              </p>
+            </div>
+          </div>
+        </div>
+        <div class="item">
+          <img src="/static/img/bubble.png">
+          <div class="carousel-caption">
+            <h2>Explore your data
+            </h2>
+            <p>
+              Intuitively navigate your data while slicing, dicing, and
+              visualizing through a rich set of widgets
+            </p>
+          </div>
+        </div>
+        <div class="item">
+          <img src="/static/img/dash.png">
+          <div class="carousel-caption">
+            <h2>Create and share dashboards</h2>
+            <p>Assemble many data visualization "slices" into a rich collection</p>
+          </div>
+        </div>
+        <div class="item">
+          <img src="/static/img/cloud.png">
+          <div class="carousel-caption">
+            <h2>Extend</h2>
+            <p>Join the community and take part in extending the widget library</p>
+          </div>
+        </div>
+        <div class="item">
+          <img src="/static/img/servers.jpg">
+          <div class="carousel-caption">
+            <h2>Connect</h2>
+            <p>
+              Access data from MySql, Presto.db, Postgres, RedShift, Oracle, MsSql,
+              SQLite, and more through the SqlAlchemy integration. You can also
+              query realtime data blazingly fast out of Druid.io
+            </p>
+          </div>
+        </div>
+      </div>
+      <!-- Controls -->
+      <div>
+        <a class="left carousel-control" href="#carousel" role="button" data-slide="prev">
+          <span class="glyphicon glyphicon-chevron-left" aria-hidden="true"></span>
+          <span class="sr-only">Previous</span>
+        </a>
+        <a class="right carousel-control" href="#carousel" role="button" data-slide="next">
+          <span class="glyphicon glyphicon-chevron-right" aria-hidden="true"></span>
+          <span class="sr-only">Next</span>
+        </a>
+      </div>
+    </div>
+    <hr/>
+    <div class="container">
+      <div class="jumbotron">
+        <h1>Panoramix</h1>
+        <p>
+        an open source data visualization platform that provides easy
+        exploration of your data and allows you to create and share
+        beautiful charts and dashboards
+        </p>
+      </div>
+    </div>
+  {% endif %}
+  <div class="container mainbody">
+  {% block body %}{% endblock %}
+  </div>
+{%- endblock %}

docs/conf.py

@@ -118,7 +118,12 @@
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+html_theme_options = {
+    #'bootswatch_theme': 'simplex',
+    'navbar_title': 'Panoramix Documentation',
+    'navbar_fixed_top': "false",
+    #'navbar_class': "navbar navbar-default",
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
@@ -227,7 +232,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  (master_doc, 'panoramix.tex', u'panoramix Documentation',
+  (master_doc, 'panoramix.tex', u'Panoramix Documentation',
    u'Maxime Beauchemin', 'manual'),
 ]
 
@@ -257,7 +262,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'panoramix', u'panoramix Documentation',
+    (master_doc, 'Panoramix', u'panoramix Documentation',
      [author], 1)
 ]
 
@@ -271,8 +276,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  (master_doc, 'panoramix', u'panoramix Documentation',
-   author, 'panoramix', 'One line description of project.',
+  (master_doc, 'Panoramix', u'Panoramix Documentation',
+   author, 'Panoramix', 'One line description of project.',
    'Miscellaneous'),
 ]
 

docs/index.rst

@@ -3,14 +3,16 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Panoramix documentation
+
+Documentation
 =======================================
+
 .. image:: img/tux_panoramix.png
 
 Panoramix is an open source data visualization platform that make it easy to
 slice, dice and visualize data.
 
-Features:
+Features
 ---------
 
 - A rich set of data visualizations, integrated from some of the best visualization libraries
@@ -21,7 +23,7 @@ Features:
 - Integration with most RDBMS through SqlAlchemy
 - Deep integration with Druid.io
 
-Contents:
+Contents
 ---------
 
 .. toctree::

panoramix/static/docs

@@ -0,0 +1 @@
+../../docs/_build/html/