diff mbox

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

Message ID 1452875732-16058-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

John McNamara Jan. 15, 2016, 4:35 p.m. UTC 
  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(-)

Comments

Thomas Monjalon Jan. 15, 2016, 10:01 p.m. UTC | #1 
2016-01-15 16:35, John McNamara:
> 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.

I'm interested to know the relation between titles and version number.
Thomas Monjalon Jan. 16, 2016, 8:15 a.m. UTC | #2 
2016-01-15 16:35, John McNamara:
> 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>

Applied, thanks
John McNamara Jan. 16, 2016, 2:34 p.m. UTC | #3 
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Friday, January 15, 2016 10:01 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [PATCH v1] doc: fix navigation levels in html sidebar
> 
> 2016-01-15 16:35, John McNamara:
> > 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.
> 
> I'm interested to know the relation between titles and version number.

Hi Thomas,

There isn't any direct relationship I think.

Removing the :titlesonly: directive made the sublevels visible, but only to the first level. Removing the stray newline in the version number made the other levels visible. This may be a bug in the Sphinx RTD theme or just some strange CSS interaction.

Thanks for rebuilding the online docs.

John.
diff mbox

Patch

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