Switch docs to use a bootstrap theme

Use the United bootswatch theme.

Change-Id: Id5d886b464573d314b793429f6aadd6e1986d147
Signed-off-by: Colin Dixon <colin@colindixon.com>
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
(cherry picked from commit 97ffd572f7595c3f13090614c93862ee2d4810d7)

diff --git a/docs/_static/odl_small.png b/docs/_static/odl_small.png
new file mode 100644 (file)
index 0000000..861e1af
Binary files /dev/null and b/docs/_static/odl_small.png differ

diff --git a/docs/conf.py b/docs/conf.py
index 3d4e5b695d60ab6ef04b07037ec1d40fac298ce6..77e62a911cf1066c9643fdc3f164ca0792c9cd2d 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,6 +15,7 @@
 
 import sys
 import os
+import sphinx_bootstrap_theme
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -109,15 +110,19 @@ 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 = 'bootstrap'
 
 # 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 = {
+    'bootswatch_theme': "united",
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
@@ -128,7 +133,7 @@ html_theme = 'alabaster'
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = '_static/odl.png'
+html_logo = '_static/odl_small.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

diff --git a/requirements.txt b/requirements.txt
new file mode 100644 (file)
index 0000000..585e338
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+sphinx
+sphinx_bootstrap_theme