diff --git a/README.md b/README.md index b5de903a17ce4..bf2f4434421be 100644 --- a/README.md +++ b/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: diff --git a/docs/_static/docs.css b/docs/_static/docs.css new file mode 100644 index 0000000000000..4b9f80728e742 --- /dev/null +++ b/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; +} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 0000000000000..f2399aef0eded --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,95 @@ +{% extends "!layout.html" %} + +{% set bootswatch_css_custom = ['_static/docs.css'] %} + +{%- block content %} + {{ navBar() }} + {% if pagename == 'index' %} + +
+
+
+

Panoramix

+

+ an open source data visualization platform that provides easy + exploration of your data and allows you to create and share + beautiful charts and dashboards +

+
+
+ {% endif %} +
+ {% block body %}{% endblock %} +
+{%- endblock %} diff --git a/docs/conf.py b/docs/conf.py index 8b17b5fb391f0..047c33e6ea540 100644 --- a/docs/conf.py +++ b/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'), ] diff --git a/docs/index.rst b/docs/index.rst index a21da6992ddbf..3fe717d456208 100644 --- a/docs/index.rst +++ b/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:: diff --git a/panoramix/static/docs b/panoramix/static/docs new file mode 120000 index 0000000000000..932170420302a --- /dev/null +++ b/panoramix/static/docs @@ -0,0 +1 @@ +../../docs/_build/html/ \ No newline at end of file