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

Message ID 1445340689-32625-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Superseded, archived
Headers

Commit Message

John McNamara Oct. 20, 2015, 11:31 a.m. UTC
  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@intel.com>
---
 doc/guides/conf.py | 2 ++
 1 file changed, 2 insertions(+)
  

Patch

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index b2290b4..8cfb7d3 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -37,6 +37,8 @@  from pygments.formatters.latex import LatexFormatter
 
 project = 'DPDK'
 
+html_theme = "sphinx_rtd_theme"
+html_add_permalinks = ""
 html_show_copyright = False
 highlight_language = 'none'