DPDK patches and discussions
 help / color / mirror / Atom feed
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH] doc: change sphinx theme to the read the docs theme
Date: Tue, 20 Oct 2015 12:31:29 +0100	[thread overview]
Message-ID: <1445340689-32625-1-git-send-email-john.mcnamara@intel.com> (raw)

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(+)

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'
 
-- 
1.8.1.4

             reply	other threads:[~2015-10-20 11:31 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-20 11:31 John McNamara [this message]
2015-10-21  9:39 ` [dpdk-dev] [PATCH v2] " John McNamara
2015-10-23 17:35   ` Van Haaren, Harry
2015-10-26 14:33   ` Thomas Monjalon
2015-11-01 16:41     ` Mcnamara, John
2015-11-01 18:36       ` Thomas Monjalon
2015-11-01 19:39         ` Mcnamara, John
2015-11-01 23:29 ` [dpdk-dev] [PATCH v4] doc: change sphinx theme and add logos John McNamara
2015-12-13 21:34   ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1445340689-32625-1-git-send-email-john.mcnamara@intel.com \
    --to=john.mcnamara@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).