[dpdk-dev] [PATCH] doc: show version in html guides

Thomas Monjalon thomas.monjalon at 6wind.com
Thu Dec 17 11:26:32 CET 2015


The version does not appear in the readthedocs theme.
We may try to customize the theme, or just update the project name
as in this patch. The project name is not used in the PDF.

Signed-off-by: Thomas Monjalon <thomas.monjalon at 6wind.com>
---
 doc/guides/conf.py | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 1861443..773c565 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -35,8 +35,6 @@ from sphinx import __version__ as sphinx_version
 from sphinx.highlighting import PygmentsBridge
 from pygments.formatters.latex import LatexFormatter
 
-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'
@@ -47,6 +45,7 @@ highlight_language = 'none'
 
 version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']).decode('utf-8')
 release = version
+project = 'Data Plane Development Kit ' + version
 
 master_doc = 'index'
 
-- 
2.5.2



More information about the dev mailing list