From: John McNamara <john.mcnamara@intel.com>
Date: Fri, 23 Jun 2017 13:05:29 +0000 (+0100)
Subject: doc: import sphinx rtd theme when available
X-Git-Tag: spdx-start~2533
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=46562be65094;p=dpdk.git

doc: import sphinx rtd theme when available

The ReadTheDocs theme is no longer available by default in
Sphinx versions >= 1.3.1 and if it isn't available then an
exception is raised. This patch imports the ReadTheDocs
theme when it is available and warns but proceeds when it
isn't.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index c3cd0bd690..39880752e2 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -47,11 +47,17 @@ except:
     # Python 3.
     import configparser
 
+try:
+    import sphinx_rtd_theme
 
-project = 'Data Plane Development Kit'
-
-if LooseVersion(sphinx_version) >= LooseVersion('1.3.1'):
     html_theme = "sphinx_rtd_theme"
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+except:
+    print('Install the sphinx ReadTheDocs theme for improved html documentation '
+          'layout: pip install sphinx_rtd_theme')
+    pass
+
+project = 'Data Plane Development Kit'
 html_logo = '../logo/DPDK_logo_vertical_rev_small.png'
 latex_logo = '../logo/DPDK_logo_horizontal_tag.png'
 html_add_permalinks = ""