Improve docs

- Add tutor logo
- add "edit on github" links
- modify theme colors
- and various other things...

README.rst

@@ -1,9 +1,18 @@
 .. _readme_intro_start:
 
-Tutor 🎓 The docker-based Open edX distribution designed for peace of mind
-==========================================================================
+Tutor: the docker-based Open edX distribution designed for peace of mind
+========================================================================
 
-.. image:: https://img.shields.io/travis/overhangio/tutor.svg?label=Release%20build
+|
+
+.. image:: https://overhang.io/images/tutor-logo.svg
+  :alt: Tutor logo
+  :width: 500px
+  :align: center
+
+|
+
+.. image:: https://img.shields.io/travis/overhangio/tutor.svg?label=Release%20build&style=flat-square
     :alt: Release build status
     :target: https://travis-ci.org/overhangio/tutor
 
@@ -11,22 +20,23 @@ Tutor 🎓 The docker-based Open edX distribution designed for peace of mind
     :alt: Release build status
     :target: https://git.overhang.io/community/tutor/commits/master
 
-.. image:: https://img.shields.io/badge/docs-current-blue.svg
+.. image:: https://img.shields.io/badge/docs-current-blue.svg?style=flat-square
     :alt: Documentation
     :target: https://docs.tutor.overhang.io
 
-.. image:: https://img.shields.io/github/issues/overhangio/tutor.svg
+.. image:: https://img.shields.io/github/issues/overhangio/tutor.svg?style=flat-square
     :alt: GitHub issues
     :target: https://github.com/overhangio/tutor/issues
 
-.. image:: https://img.shields.io/github/issues-closed/overhangio/tutor.svg?colorB=brightgreen
+.. image:: https://img.shields.io/github/issues-closed/overhangio/tutor.svg?colorB=brightgreen&style=flat-square
     :alt: GitHub closed issues
     :target: https://github.com/overhangio/tutor/issues?q=is%3Aclosed
 
-.. image:: https://img.shields.io/github/license/overhangio/tutor.svg
+.. image:: https://img.shields.io/github/license/overhangio/tutor.svg?style=flat-square
     :alt: AGPL License
     :target: https://www.gnu.org/licenses/agpl-3.0.en.html
 
+
 **Tutor** is a docker-based `Open edX <https://openedx.org>`_ distribution, both for production and local development. The goal of Tutor is to make it easy to deploy, customize, upgrade and scale Open edX. Tutor is reliable, fast, extensible, and it is already used by dozens of Open edX platforms in the world.
 
 Features

docs/Makefile

@@ -8,4 +8,4 @@ browse:
 	sensible-browser _build/html/index.html
 
 watch: html browse
-	while true; do inotifywait -e modify *.rst ../*.rst; $(MAKE) html; done
+	while true; do inotifywait -e modify *.rst ../*.rst conf.py; $(MAKE) html; done

docs/conf.py

@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Tutor'
-copyright = '2018, Overhang.io'
+copyright = ""
 author = 'Overhang.io'
 
 # The short X.Y version
@@ -80,7 +80,18 @@ html_theme = 'sphinx_rtd_theme'
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'logo_only': True,
+    "style_nav_header_background": "#EFEFEF",
+}
+
+html_context = {
+  'display_github': True,
+  'github_user': 'overhangio',
+  'github_repo': 'tutor',
+  'github_version': 'master',
+  "conf_py_path": "/docs/"
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -97,6 +108,16 @@ html_static_path = ['img']
 #
 # html_sidebars = {}
 
+# Custom settings
+html_logo = "./img/tutor-logo.png"
+html_show_sourcelink = False
+html_display_github = True
+html_show_sphinx = False
+html_github_user = "overhangio"
+html_github_repo = "tutor"
+# Images do not link to themselves
+html_scaled_image_link = False
+html_show_copyright = False
 
 # -- Options for HTMLHelp output ---------------------------------------------
 

docs/intro.rst

@@ -10,6 +10,11 @@ Tutor simplifies the deployment of Open edX by:
 1. Separating the configuration logic from the deployment platforms.
 2. Running application processes in cleanly separated `docker containers <https://www.docker.com/resources/what-container>`_.
 
+.. image:: https://overhang.io/images/openedx-plus-docker-is-tutor.png
+  :alt: Open edX + Docker = Tutor
+  :width: 500px
+  :align: center
+
 Because Docker containers are becoming an industry-wide standard, that means that with Tutor it becomes possible to run Open edX anywhere: for now, Tutor supports deploying on a local server, with `docker-compose <https://docs.docker.com/compose/overview/>`_, and in a large cluster, with `Kubernetes <http://kubernetes.io/>`_. But in the future, Tutor may support other deployment platforms.
 
 .. include:: ../README.rst