diff --git a/caravel/assets/images/tutorial/created.png b/caravel/assets/images/tutorial/created.png new file mode 100644 index 000000000..8204ffa05 Binary files /dev/null and b/caravel/assets/images/tutorial/created.png differ diff --git a/caravel/assets/images/tutorial/db_added.png b/caravel/assets/images/tutorial/db_added.png new file mode 100644 index 000000000..a2865fc21 Binary files /dev/null and b/caravel/assets/images/tutorial/db_added.png differ diff --git a/caravel/assets/images/tutorial/db_menu.png b/caravel/assets/images/tutorial/db_menu.png new file mode 100644 index 000000000..4cd984146 Binary files /dev/null and b/caravel/assets/images/tutorial/db_menu.png differ diff --git a/caravel/assets/images/tutorial/db_plus.png b/caravel/assets/images/tutorial/db_plus.png new file mode 100644 index 000000000..ea918a7f7 Binary files /dev/null and b/caravel/assets/images/tutorial/db_plus.png differ diff --git a/caravel/assets/images/tutorial/explore.png b/caravel/assets/images/tutorial/explore.png new file mode 100644 index 000000000..29e62e427 Binary files /dev/null and b/caravel/assets/images/tutorial/explore.png differ diff --git a/caravel/assets/images/tutorial/in_new_dash.png b/caravel/assets/images/tutorial/in_new_dash.png new file mode 100644 index 000000000..59e7bd75a Binary files /dev/null and b/caravel/assets/images/tutorial/in_new_dash.png differ diff --git a/caravel/assets/images/tutorial/matrix.png b/caravel/assets/images/tutorial/matrix.png new file mode 100644 index 000000000..1b4d80697 Binary files /dev/null and b/caravel/assets/images/tutorial/matrix.png differ diff --git a/caravel/assets/images/tutorial/new_dash.png b/caravel/assets/images/tutorial/new_dash.png new file mode 100644 index 000000000..a2a104dcb Binary files /dev/null and b/caravel/assets/images/tutorial/new_dash.png differ diff --git a/caravel/assets/images/tutorial/pen.png b/caravel/assets/images/tutorial/pen.png new file mode 100644 index 000000000..d492d1883 Binary files /dev/null and b/caravel/assets/images/tutorial/pen.png differ diff --git a/caravel/assets/images/tutorial/search.png b/caravel/assets/images/tutorial/search.png new file mode 100644 index 000000000..dbdb2875d Binary files /dev/null and b/caravel/assets/images/tutorial/search.png differ diff --git a/dev-reqs.txt b/dev-reqs.txt index 98517cecb..a29fb76ad 100644 --- a/dev-reqs.txt +++ b/dev-reqs.txt @@ -1,3 +1,4 @@ coveralls +pillow sphinx sphinx_bootstrap_theme diff --git a/docs/_static/docs.css b/docs/_static/docs.css index 4b9f80728..ffbb03970 100644 --- a/docs/_static/docs.css +++ b/docs/_static/docs.css @@ -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; } diff --git a/docs/build.sh b/docs/build.sh index 8347f2a47..6f343e898 100755 --- a/docs/build.sh +++ b/docs/build.sh @@ -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 diff --git a/docs/conf.py b/docs/conf.py index c362857ad..37c10e4fe 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 tag referring to it. The value of this option must be the diff --git a/docs/index.rst b/docs/index.rst index 1008b7c22..27c169c5d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/user_guide.rst b/docs/videos.rst similarity index 93% rename from docs/user_guide.rst rename to docs/videos.rst index 20758ff56..7218b9b72 100644 --- a/docs/user_guide.rst +++ b/docs/videos.rst @@ -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