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