diff mbox series

[1/3] doc: robustify PDF build

Message ID 20190522202842.19818-2-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Headers
Series fix PDF doc build |

Checks

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

Commit Message

Thomas Monjalon May 22, 2019, 8:28 p.m. UTC 
  In some environment like the current dpdk.org server,
there can be some errors due to symbols in titles,
as it was the case before this commit in DPDK 18.05:
551d148944dc ("doc: remove flow API migration section")

	! LaTeX Error: Bad math environment delimiter.

It can be avoided thanks to the Latex command \robustify.

Cc: stable@dpdk.org

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

Comments

John McNamara May 23, 2019, 11:16 a.m. UTC | #1 
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Wednesday, May 22, 2019 9:29 PM
> To: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>; Kovacevic,
> Marko <marko.kovacevic@intel.com>
> Cc: stable@dpdk.org
> Subject: [PATCH 1/3] doc: robustify PDF build
> 
> In some environment like the current dpdk.org server, there can be some
> errors due to symbols in titles, as it was the case before this commit in
> DPDK 18.05:
> 551d148944dc ("doc: remove flow API migration section")
> 
> 	! LaTeX Error: Bad math environment delimiter.
> 
> It can be avoided thanks to the Latex command \robustify.
> 

Acked-by: John McNamara <john.mcnamara@intel.com>
diff mbox series

Patch

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index a85f6c9d9..6d5001a07 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -67,6 +67,9 @@ 
 \usepackage{helvet}
 \renewcommand{\familydefault}{\sfdefault}
 \RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}
+\usepackage{etoolbox}
+\robustify\(
+\robustify\)
 """
 
 # Configuration for the latex/pdf docs.