doc: import sphinx rtd theme when available
authorJohn McNamara <john.mcnamara@intel.com>
Fri, 23 Jun 2017 13:05:29 +0000 (14:05 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Sun, 9 Jul 2017 22:46:38 +0000 (00:46 +0200)
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>
doc/guides/conf.py

index c3cd0bd..3988075 100644 (file)
@@ -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 = ""