Adding a tutorial

This commit is contained in:
Maxime Beauchemin 2016-04-02 23:11:52 -07:00
parent 93405dc23a
commit d2f51900f1
16 changed files with 29 additions and 13 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 190 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 245 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 133 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 141 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

View File

@ -1,3 +1,4 @@
coveralls
pillow
sphinx
sphinx_bootstrap_theme

11
docs/_static/docs.css vendored
View File

@ -6,6 +6,17 @@ div.navbar {
margin-bottom: 0px;
}
p {
margin-top: 5px;
margin-bottom: 15px;
}
#tutorial img {
border: 1px solid gray;
box-shadow: 5px 5px 5px #888888;
margin-bottom: 10px;
}
.carousel img {
max-height: 500px;
}

View File

@ -1,6 +1,7 @@
#!/usr/bin/env bash
rm -rf _build
make html
cp -r ../caravel/assets/images/ _build/html/_static/img/
#cp -r ../caravel/assets/images/ _build/html/_static/img/
cp -r ../caravel/assets/images/ _static/img/
rm -rf /tmp/caravel-docs
cp -r _build/html /tmp/caravel-docs

View File

@ -188,7 +188,7 @@ html_show_sourcelink = False
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
html_show_copyright = False
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the

View File

@ -1,3 +1,5 @@
.. image:: _static/img/caravel.jpg
.. warning:: This project used to be name Panoramix and has been renamed
to Caravel in March 2016
@ -8,17 +10,17 @@ Features
---------
- A rich set of data visualizations, integrated from some of the best
visualization libraries
visualization libraries
- Create and share simple dashboards
- An extensible, high-granularity security/permission model allowing
intricate rules on who can access individual features and the dataset
intricate rules on who can access individual features and the dataset
- Enterprise-ready authentication with integration with major authentication
providers (database, OpenID, LDAP, OAuth & REMOTE_USER through
Flask AppBuilder)
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
@ -29,7 +31,8 @@ Contents
:maxdepth: 2
installation
user_guide
tutorial
videos
Indices and tables

View File

@ -1,7 +1,7 @@
User Guide
==========
Videos
======
The user guide is a collection of short videos showing different aspect
Here is a collection of short videos showing different aspect
of Caravel.
Quick Intro