All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] doc: show version in html guides
@ 2015-12-17 10:26 Thomas Monjalon
  2015-12-18 10:27 ` Mcnamara, John
  0 siblings, 1 reply; 5+ messages in thread
From: Thomas Monjalon @ 2015-12-17 10:26 UTC (permalink / raw)
  To: John McNamara; +Cc: dev

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

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] doc: show version in html guides
  2015-12-17 10:26 [PATCH] doc: show version in html guides Thomas Monjalon
@ 2015-12-18 10:27 ` Mcnamara, John
  2015-12-18 10:46   ` Thomas Monjalon
  0 siblings, 1 reply; 5+ messages in thread
From: Mcnamara, John @ 2015-12-18 10:27 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Thursday, December 17, 2015 10:27 AM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: [PATCH] doc: show version in html guides
> 
> 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.

Hi,

I see the version number in generated docs:

    http://i.imgur.com/GkvNz2U.png

However, I can see that it doesn't appear on the dpdk.org version.

I am using:

    $ sphinx-build --version
    Sphinx (sphinx-build) 1.3.1


John

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] doc: show version in html guides
  2015-12-18 10:27 ` Mcnamara, John
@ 2015-12-18 10:46   ` Thomas Monjalon
  2015-12-18 12:41     ` Mcnamara, John
  0 siblings, 1 reply; 5+ messages in thread
From: Thomas Monjalon @ 2015-12-18 10:46 UTC (permalink / raw)
  To: Mcnamara, John; +Cc: dev

2015-12-18 10:27, Mcnamara, John:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > 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.
> 
> Hi,
> 
> I see the version number in generated docs:
> 
>     http://i.imgur.com/GkvNz2U.png

Interesting.

> However, I can see that it doesn't appear on the dpdk.org version.
> 
> I am using:
> 
>     $ sphinx-build --version
>     Sphinx (sphinx-build) 1.3.1

Same version on dpdk.org.
There should be something else different...

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] doc: show version in html guides
  2015-12-18 10:46   ` Thomas Monjalon
@ 2015-12-18 12:41     ` Mcnamara, John
  2015-12-18 16:03       ` Thomas Monjalon
  0 siblings, 1 reply; 5+ messages in thread
From: Mcnamara, John @ 2015-12-18 12:41 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev


> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Friday, December 18, 2015 10:46 AM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [PATCH] doc: show version in html guides
> 
> 2015-12-18 10:27, Mcnamara, John:
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > 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.
> >
> > Hi,
> >
> > I see the version number in generated docs:
> >
> >     http://i.imgur.com/GkvNz2U.png
> 
> Interesting.
> 
> > However, I can see that it doesn't appear on the dpdk.org version.
> >
> > I am using:
> >
> >     $ sphinx-build --version
> >     Sphinx (sphinx-build) 1.3.1
> 
> Same version on dpdk.org.
> There should be something else different...


It could be the version of the RTD theme:


    $ python -c "import sphinx_rtd_theme; print sphinx_rtd_theme.__version__"
    0.1.9

0.1.9 is required for the version number in the Navbar:

    https://github.com/snide/sphinx_rtd_theme#v0-1-9

John.
-- 

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] doc: show version in html guides
  2015-12-18 12:41     ` Mcnamara, John
@ 2015-12-18 16:03       ` Thomas Monjalon
  0 siblings, 0 replies; 5+ messages in thread
From: Thomas Monjalon @ 2015-12-18 16:03 UTC (permalink / raw)
  To: Mcnamara, John; +Cc: dev

2015-12-18 12:41, Mcnamara, John:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > 2015-12-18 10:27, Mcnamara, John:
> > > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > > 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.
> > >
> > > Hi,
> > >
> > > I see the version number in generated docs:
> > >
> > >     http://i.imgur.com/GkvNz2U.png
> > 
> > Interesting.
> > 
> > > However, I can see that it doesn't appear on the dpdk.org version.
> > >
> > > I am using:
> > >
> > >     $ sphinx-build --version
> > >     Sphinx (sphinx-build) 1.3.1
> > 
> > Same version on dpdk.org.
> > There should be something else different...
> 
> 
> It could be the version of the RTD theme:
> 
> 
>     $ python -c "import sphinx_rtd_theme; print sphinx_rtd_theme.__version__"
>     0.1.9
> 
> 0.1.9 is required for the version number in the Navbar:
> 
>     https://github.com/snide/sphinx_rtd_theme#v0-1-9

0.1.8 here.

So this patch is rejected and the doc should be regenerated on dpdk.org.

Thanks

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2015-12-18 16:04 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-12-17 10:26 [PATCH] doc: show version in html guides Thomas Monjalon
2015-12-18 10:27 ` Mcnamara, John
2015-12-18 10:46   ` Thomas Monjalon
2015-12-18 12:41     ` Mcnamara, John
2015-12-18 16:03       ` Thomas Monjalon

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.