diff mbox

[dpdk-dev,v1] doc: import sphinx rtd doc theme when available

Message ID 1498223129-28590-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

John McNamara June 23, 2017, 1:05 p.m. UTC 
  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 | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

Comments

Thomas Monjalon July 9, 2017, 9:22 p.m. UTC | #1 
23/06/2017 15:05, John McNamara:
> 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>

Applied, thanks
diff mbox

Patch

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index c3cd0bd..3988075 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -47,11 +47,17 @@ 
     # 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 = ""