[dpdk-dev] [PATCH v1] doc: fix navigation levels in html sidebar

John McNamara john.mcnamara at intel.com
Fri Jan 15 17:35:32 CET 2016


Fix issue where the navigation levels weren't displayed in the
html sidebar with the new read_the_docs theme.

This was due to the :titlesonly: directive in the high level
index.rst and also due to a stray newline in the parsed version
number.

Signed-off-by: John McNamara <john.mcnamara at intel.com>
---
 doc/guides/conf.py   | 2 +-
 doc/guides/index.rst | 1 -
 2 files changed, 1 insertion(+), 2 deletions(-)

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 1861443..2c5610f 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -45,7 +45,7 @@ html_add_permalinks = ""
 html_show_copyright = False
 highlight_language = 'none'
 
-version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']).decode('utf-8')
+version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']).decode('utf-8').rstrip()
 release = version
 
 master_doc = 'index'
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 638eab9..7aef7a3 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -33,7 +33,6 @@ DPDK documentation
 
 .. toctree::
    :maxdepth: 1
-   :titlesonly:
 
    linux_gsg/index
    freebsd_gsg/index
-- 
2.5.0



More information about the dev mailing list