[dpdk-dev] [PATCH 0/3] fix PDF doc build

[dpdk-dev] [PATCH 0/3] fix PDF doc build

[Thomas Monjalon]

I found different issues when building the doc as PDF on the server
or my laptop.
Debugging pdflatex issues is really hard, so I hope we won't have more.

We could also question why we are bothering with PDF?


Thomas Monjalon (3):
  doc: robustify PDF build
  doc: fix PDF with greek letter
  doc: clean PDF config

 doc/guides/conf.py                        | 8 ++++----
 doc/guides/contributing/documentation.rst | 4 ++--
 2 files changed, 6 insertions(+), 6 deletions(-)

-- 
2.21.0

[dpdk-dev] [PATCH 1/3] doc: robustify PDF build

[Thomas Monjalon]

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(+)

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.
-- 
2.21.0

Re: [dpdk-dev] [PATCH 1/3] doc: robustify PDF build

[Mcnamara, John]

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

[dpdk-dev] [PATCH 2/3] doc: fix PDF with greek letter

[Thomas Monjalon]

For an unknown reason, the sign "μ" is not accepted by some environments,
probably due to the version of some Latex packages or dependencies.

	! Package inputenc Error: Unicode character μ (U+03BC)
	(inputenc)                not set up for use with LaTeX.

It is fixed by installing texlive-langgreek.

Fixes: d0dff9ba445e ("doc: sample application user guide")
Cc: stable@dpdk.org

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

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 6d5001a07..94b97dc35 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -64,6 +64,7 @@
 custom_latex_preamble = r"""
 \usepackage[utf8]{inputenc}
 \usepackage[T1]{fontenc}
+\usepackage{textalpha}
 \usepackage{helvet}
 \renewcommand{\familydefault}{\sfdefault}
 \RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}
diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index 9d381919b..27e4b13be 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -199,10 +199,10 @@ The main required packages can be installed as follows:
 .. code-block:: console
 
    # Ubuntu/Debian.
-   sudo apt-get -y install texlive-latex-extra
+   sudo apt-get -y install texlive-latex-extra texlive-lang-greek
 
    # Red Hat/Fedora, selective install.
-   sudo dnf     -y install texlive-collection-latexextra
+   sudo dnf     -y install texlive-collection-latexextra texlive-greek-fontenc
 
 `Latexmk <http://personal.psu.edu/jcc8/software/latexmk-jcc/>`_ is a perl script
 for running LaTeX for resolving cross references,
-- 
2.21.0

Re: [dpdk-dev] [PATCH 2/3] doc: fix PDF with greek letter

[Mcnamara, John]

> -----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 2/3] doc: fix PDF with greek letter
> 
> For an unknown reason, the sign "μ" is not accepted by some environments,
> probably due to the version of some Latex packages or dependencies.
> 
> 	! Package inputenc Error: Unicode character μ (U+03BC)
> 	(inputenc)                not set up for use with LaTeX.
> 
> It is fixed by installing texlive-langgreek.
> 

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

[dpdk-dev] [PATCH 3/3] doc: clean PDF config

[Thomas Monjalon]

Some font options do not look necessary.

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

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 94b97dc35..e2b52e2df 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -62,11 +62,7 @@
 
 # Latex directives to be included directly in the latex/pdf docs.
 custom_latex_preamble = r"""
-\usepackage[utf8]{inputenc}
-\usepackage[T1]{fontenc}
 \usepackage{textalpha}
-\usepackage{helvet}
-\renewcommand{\familydefault}{\sfdefault}
 \RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}
 \usepackage{etoolbox}
 \robustify\(
-- 
2.21.0

Re: [dpdk-dev] [PATCH 3/3] doc: clean PDF config

[Mcnamara, John]

> -----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>
> Subject: [PATCH 3/3] doc: clean PDF config
> 
> Some font options do not look necessary.
> 

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

Re: [dpdk-dev] [PATCH 0/3] fix PDF doc build

[Thomas Monjalon]

> Thomas Monjalon (3):
>   doc: robustify PDF build
>   doc: fix PDF with greek letter
>   doc: clean PDF config

Applied