Doc updates

docs/source/conf.py

@@ -21,6 +21,13 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+from homeassistant.const import (__version__, __short_version__, PROJECT_NAME,
+                                 PROJECT_LONG_DESCRIPTION, PROJECT_URL,
+                                 PROJECT_COPYRIGHT, PROJECT_AUTHOR,
+                                 PROJECT_GITHUB_USERNAME,
+                                 PROJECT_GITHUB_REPOSITORY, PYPI_URL,
+                                 GITHUB_URL)
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -53,18 +60,18 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = 'Home Assistant'
-copyright = '2016, Home Assistant Team'
-author = 'Home Assistant Team'
+project = PROJECT_NAME
+copyright = PROJECT_COPYRIGHT
+author = PROJECT_AUTHOR
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.27'
+version = __short_version__
 # The full version, including alpha/beta/rc tags.
-release = '0.27.0'
+release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -124,13 +131,31 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-# html_theme = 'alabaster'
+html_theme = 'alabaster'
 
 # 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 = {
+    'logo': 'logo.png',
+    'logo_name': PROJECT_NAME,
+    'description': PROJECT_LONG_DESCRIPTION,
+    'github_user': PROJECT_GITHUB_USERNAME,
+    'github_repo': PROJECT_GITHUB_REPOSITORY,
+    'github_type': 'star',
+    'github_banner': True,
+    'travis_button': True,
+    'touch_icon': 'logo-apple.png',
+    # 'fixed_sidebar': True, # Re-enable when we have more content
+    'extra_nav_links': {
+        '🏡 Homepage': PROJECT_URL,
+        '📌 Community Forums': 'https://community.home-assistant.io',
+        '💬 Gitter': 'https://gitter.im/home-assistant/home-assistant',
+        '🚀 GitHub': GITHUB_URL,
+        '💾 Download Releases': PYPI_URL,
+    }
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -147,13 +172,14 @@ todo_include_todos = False
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-# html_logo = None
+# html_logo = '_static/logo.png'
 
 # The name of an image file (relative to this directory) to use as a favicon of
-# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# the docs.
+# This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #
-# html_favicon = None
+html_favicon = '_static/favicon.ico'
 
 # 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,
@@ -170,16 +196,23 @@ html_static_path = ['_static']
 # bottom, using the given strftime format.
 # The empty string is equivalent to '%b %d, %Y'.
 #
-# html_last_updated_fmt = None
+html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 #
-# html_use_smartypants = True
+html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
 #
-# html_sidebars = {}
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+    ]
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.