Message ID | 1450347992-25835-1-git-send-email-thomas.monjalon@6wind.com (mailing list archive) |
---|---|
State | Rejected, archived |
Headers |
Return-Path: <dev-bounces@dpdk.org> X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 888627E23; Thu, 17 Dec 2015 11:27:57 +0100 (CET) Received: from mail-wm0-f41.google.com (mail-wm0-f41.google.com [74.125.82.41]) by dpdk.org (Postfix) with ESMTP id 1D06268A5 for <dev@dpdk.org>; Thu, 17 Dec 2015 11:27:56 +0100 (CET) Received: by mail-wm0-f41.google.com with SMTP id l126so14669465wml.1 for <dev@dpdk.org>; Thu, 17 Dec 2015 02:27:56 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id; bh=7x+OAq28/f1FkpitOLzYSJeGbCvWbEx6AjXPp+mHRdM=; b=e8CnNUycBANo9hlxaJx9cJcMuzdJokr9RDdX/dJuzXQycHNgyvIY0TwuYt30TLb1lI EuW7ovnrPdHdtLj5cW1cFZwaaIRC5m3pyfGqg1C7zAidbou1YrKyyMpJeTP+qRtmz8Co 1cXEKGyFAH6ikwmoB4dBEoVdeGsnRhcAwrvqHInlfyrbRM0ZvpnHJ6lJJ7AsY9cf6YVQ I+U1VVe4Lhp9XOmxx1wyaXPXMLoZNxSqA6x3dA/0DpuP0p75qnsjcUvR/akYKdPxeSOq +T2FBdHqM8ZYfDJrTlddNmU2uWI0qdn3DjkMEu63BDqYvDcDnv6sppUCtDJEcb+GbrPT MMhA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=7x+OAq28/f1FkpitOLzYSJeGbCvWbEx6AjXPp+mHRdM=; b=e3aXJoQ/NpvrPbCPBVbui5tWqaiDHO/pfuuy5/sp+n21kKrOyuhgZNTotQ5h7IGEOc IslSa/wxtrr3DR/5JW2O/UP4M0O3LkGQ5eyIPiA5PN7X1/ZPWB5tdW2rvx9BGf3Rp8TF G+0mqLC3quNZfIduz/TpodOLDC0G06u+jZx6gYDC4jxzZzdnCi7N6nlSu6Y63Hnxpmx0 28pZdxXPzhDJsdYFjt82l7LqU+5vZHgCqH4NIr6bvna0yAIDI6Cd6qf4mWNO6xhDgxFm OUMrY8X2DY+tvL5EfTJFm9rLjAaFfAtVcggnRdoqMeCRDm/iFd1zpJsQujT+OB5nhIVd 1DPg== X-Gm-Message-State: ALoCoQm4UX7iHr5jGZzhxbSta9Z/icPsNQoP9hqsPgInjoQAXN7353c6ESzoVfszuD2BS1Q68AirC+/jDP3S7syS3jqGld8sWA== X-Received: by 10.28.133.8 with SMTP id h8mr3121545wmd.71.1450348075873; Thu, 17 Dec 2015 02:27:55 -0800 (PST) Received: from XPS13.dev.6wind.com (guy78-3-82-239-227-177.fbx.proxad.net. [82.239.227.177]) by smtp.gmail.com with ESMTPSA id cl2sm9772461wjc.33.2015.12.17.02.27.54 (version=TLSv1/SSLv3 cipher=OTHER); Thu, 17 Dec 2015 02:27:54 -0800 (PST) From: Thomas Monjalon <thomas.monjalon@6wind.com> To: John McNamara <john.mcnamara@intel.com> Date: Thu, 17 Dec 2015 11:26:32 +0100 Message-Id: <1450347992-25835-1-git-send-email-thomas.monjalon@6wind.com> X-Mailer: git-send-email 2.5.2 Cc: dev@dpdk.org Subject: [dpdk-dev] [PATCH] doc: show version in html guides X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK <dev.dpdk.org> List-Unsubscribe: <http://dpdk.org/ml/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://dpdk.org/ml/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <http://dpdk.org/ml/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> |
Commit Message
Thomas Monjalon
Dec. 17, 2015, 10:26 a.m. UTC
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(-)
Comments
> -----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
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...
> -----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. --
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
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'