From mboxrd@z Thu Jan 1 00:00:00 1970 From: John McNamara Subject: [PATCH v2] doc: change sphinx theme to the read the docs theme Date: Wed, 21 Oct 2015 10:39:02 +0100 Message-ID: <1445420342-25227-1-git-send-email-john.mcnamara@intel.com> References: <1445340689-32625-1-git-send-email-john.mcnamara@intel.com> To: dev@dpdk.org Return-path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id B02A893B4 for ; Wed, 21 Oct 2015 11:39:13 +0200 (CEST) In-Reply-To: <1445340689-32625-1-git-send-email-john.mcnamara@intel.com> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- 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