[dpdk-dev] doc: fix sphinx warning

Message ID 20170419121036.4408-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Thomas Monjalon April 19, 2017, 12:10 p.m. UTC
  Seen with recent version of sphinx:
WARNING: latex_preamble conflicts with latex_elements['preamble'], ignored.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/conf.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
  

Comments

Ferruh Yigit April 19, 2017, 12:21 p.m. UTC | #1
On 4/19/2017 1:10 PM, Thomas Monjalon wrote:
> Seen with recent version of sphinx:
> WARNING: latex_preamble conflicts with latex_elements['preamble'], ignored.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Tested-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Thomas Monjalon April 19, 2017, 1:25 p.m. UTC | #2
19/04/2017 14:21, Ferruh Yigit:
> On 4/19/2017 1:10 PM, Thomas Monjalon wrote:
> > Seen with recent version of sphinx:
> > WARNING: latex_preamble conflicts with latex_elements['preamble'],
> > ignored.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Tested-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied
  
Van Haaren, Harry April 19, 2017, 2:16 p.m. UTC | #3
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Thomas Monjalon
> Sent: Wednesday, April 19, 2017 1:11 PM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: fix sphinx warning
> 
> Seen with recent version of sphinx:
> WARNING: latex_preamble conflicts with latex_elements['preamble'], ignored.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Previously I had this warning, but no more, whooo!

Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
  

Patch

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 01ce16d2e..ef0e1c607 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -79,7 +79,7 @@ 
 ]
 
 # Latex directives to be included directly in the latex/pdf docs.
-latex_preamble = r"""
+custom_latex_preamble = r"""
 \usepackage[utf8]{inputenc}
 \usepackage[T1]{fontenc}
 \usepackage{helvet}
@@ -95,7 +95,7 @@ 
     'classoptions': ',openany,oneside',
     'babel': '\\usepackage[english]{babel}',
     # customize Latex formatting
-    'preamble': latex_preamble
+    'preamble': custom_latex_preamble
 }