DPDK patches and discussions
 help / color / mirror / Atom feed
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v1] doc: fix navigation levels in html sidebar
Date: Fri, 15 Jan 2016 16:35:32 +0000	[thread overview]
Message-ID: <1452875732-16058-1-git-send-email-john.mcnamara@intel.com> (raw)

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@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

             reply	other threads:[~2016-01-15 16:35 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-15 16:35 John McNamara [this message]
2016-01-15 22:01 ` Thomas Monjalon
2016-01-16 14:34   ` Mcnamara, John
2016-01-16  8:15 ` 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=1452875732-16058-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).