[dpdk-dev] [PATCH v2] doc: change sphinx theme to the read the docs theme

John McNamara john.mcnamara at intel.com
Wed Oct 21 11:39:02 CEST 2015


Change the Sphinx default theme from "alabaster" to the ReadTheDocs
theme. See for example:

    http://dpdk.readthedocs.org/en/latest/

This looks better for technical documentation and in particular
it has a 80 char wide verbatim block rendering.

Also turn off option for distracting Html mouseover permalinks.

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

v2:
* Add version check since rtd theme is only available, by default,
  in Sphinx 1.3.1 and later.

 doc/guides/conf.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index b2290b4..a87bb06 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -37,6 +37,10 @@ from pygments.formatters.latex import LatexFormatter
 
 project = 'DPDK'
 
+if LooseVersion(sphinx_version) >= LooseVersion('1.3.1'):
+    html_theme = "sphinx_rtd_theme"
+
+html_add_permalinks = ""
 html_show_copyright = False
 highlight_language = 'none'
 
-- 
1.8.1.4



More information about the dev mailing list