[#213] Improve docs theme

Makefile

@@ -1,4 +1,4 @@
-.PHONY: help frontend
+.PHONY: help frontend docs docs-watch
 
 .DEFAULT_GOAL := help
 

docs/_static/css/goodtables.css

@@ -0,0 +1,31 @@
+@import url("theme.css");
+
+body {
+  font-family: frictionlessdata, Raleway, Helvetica Neue, Helvetica, Arial, sans-serif;
+  text-rendering: optimizeLegibility;
+  color: #333;
+}
+
+.wy-nav-side,
+.wy-side-nav-search {
+  background: #01578a;
+  color: #fff;
+}
+
+.wy-menu-vertical a {
+  color: #fff;
+  font-weight: 400;
+  padding: 10px 16px;
+}
+
+.wy-menu-vertical a:hover {
+  background: #3479A2;
+}
+
+.wy-menu-vertical li.current > a {
+  font-weight: normal;
+}
+
+.wy-side-nav-search > a img.logo {
+  width: 210px;
+}

docs/conf.py

@@ -48,7 +48,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'Goodtables'
+project = 'goodtables.io'
 copyright = '2017, Open Knowledge International'
 author = 'Open Knowledge International'
 
@@ -85,38 +85,24 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # 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 = {
-    'description': 'Continuous validation for tabular datasets',
-    'github_user': 'frictionlessdata',
-    'github_repo': 'goodtables.io',
-    'github_type': 'star',
-    'github_count': False,
+    'logo_only': True,
 }
 
+html_style = 'css/goodtables.css'
+html_logo = '_static/img/logo.svg'
+
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# This is required for the alabaster theme
-# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
-html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'searchbox.html',
-    ]
-}
-
 
 # -- Options for HTMLHelp output ------------------------------------------
 
@@ -148,7 +134,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'Goodtables.tex', 'Goodtables Documentation',
+    (master_doc, 'Goodtables.tex', 'Goodtables.io Documentation',
      'Open Knowledge International', 'manual'),
 ]
 
@@ -158,7 +144,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'goodtables', 'Goodtables Documentation',
+    (master_doc, 'goodtables.io', 'Goodtables.io Documentation',
      [author], 1)
 ]
 
@@ -169,8 +155,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Goodtables', 'Goodtables Documentation',
-     author, 'Goodtables', 'One line description of project.',
+    (master_doc, 'Goodtables.io', 'Goodtables.io Documentation',
+     author, 'Goodtables.io', 'Continuous tabular data validation.',
      'Miscellaneous'),
 ]
 

docs/index.md

@@ -11,7 +11,7 @@ checks on it. It is able to validate things like:
 If any of the checks fail, goodtables generates a report telling you which and
 where the errors occurred.
 
-[![Example report with failed validation](img/failed_validation.png)][bhx-schools]
+[![Example report with failed validation](_static/img/failed_validation.png)][bhx-schools]
 
 By adding goodtables to your data publishing workflow, you'll make sure your
 data is free from these types of errors.