doc: change theme of guides
authorJohn McNamara <john.mcnamara@intel.com>
Sun, 1 Nov 2015 23:29:13 +0000 (23:29 +0000)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Sun, 13 Dec 2015 21:30:47 +0000 (22:30 +0100)
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 add logos for the html and latex docs.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
doc/guides/conf.py
doc/logo/DPDK_logo_horizontal_tag.png [new file with mode: 0644]
doc/logo/DPDK_logo_vertical_rev_small.png [new file with mode: 0644]

index be20f73..1861443 100644 (file)
@@ -35,8 +35,12 @@ from sphinx import __version__ as sphinx_version
 from sphinx.highlighting import PygmentsBridge
 from pygments.formatters.latex import LatexFormatter
 
-project = 'DPDK'
+project = 'Data Plane Development Kit'
 
+if LooseVersion(sphinx_version) >= LooseVersion('1.3.1'):
+    html_theme = "sphinx_rtd_theme"
+html_logo = '../logo/DPDK_logo_vertical_rev_small.png'
+latex_logo = '../logo/DPDK_logo_horizontal_tag.png'
 html_add_permalinks = ""
 html_show_copyright = False
 highlight_language = 'none'
diff --git a/doc/logo/DPDK_logo_horizontal_tag.png b/doc/logo/DPDK_logo_horizontal_tag.png
new file mode 100644 (file)
index 0000000..8c2e35d
Binary files /dev/null and b/doc/logo/DPDK_logo_horizontal_tag.png differ
diff --git a/doc/logo/DPDK_logo_vertical_rev_small.png b/doc/logo/DPDK_logo_vertical_rev_small.png
new file mode 100644 (file)
index 0000000..a418043
Binary files /dev/null and b/doc/logo/DPDK_logo_vertical_rev_small.png differ