[dpdk-dev] [PATCH] doc: fix PDF build

[dpdk-dev] [PATCH] doc: fix PDF build

[Thomas Monjalon]

The command "make doc-guides-pdf" is failing because
there are more than 1500 lines in the file MAINTAINERS
which is included in the contributing guide.

We are facing the issue mentioned in this comment:
https://github.com/sphinx-doc/sphinx/issues/3099#issuecomment-256440704

Anyway the file MAINTAINERS is mentioned several times in the guide.
So the "literalinclude" is removed from the guide to fix the build
of the PDF.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/contributing/patches.rst | 9 ---------
 1 file changed, 9 deletions(-)

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 3b2b174ad..f37fb5557 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -648,12 +648,3 @@ patch accepted. The general cycle for patch review and acceptance is:
      than rework of the original.
    * Trivial patches may be merged sooner than described above at the tree committer's
      discretion.
-
-DPDK Maintainers
-----------------
-
-The following are the DPDK maintainers as listed in the ``MAINTAINERS`` file
-in the DPDK root directory.
-
-.. literalinclude:: ../../../MAINTAINERS
-   :lines: 3-
-- 
2.21.0

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

[Ferruh Yigit]

On 7/9/2019 2:11 PM, Thomas Monjalon wrote:
> The command "make doc-guides-pdf" is failing because
> there are more than 1500 lines in the file MAINTAINERS
> which is included in the contributing guide.
> 
> We are facing the issue mentioned in this comment:
> https://github.com/sphinx-doc/sphinx/issues/3099#issuecomment-256440704
> 
> Anyway the file MAINTAINERS is mentioned several times in the guide.
> So the "literalinclude" is removed from the guide to fix the build
> of the PDF.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Tested-by: Ferruh Yigit <ferruh.yigit@intel.com>

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

[Thomas Monjalon]

09/07/2019 18:53, Ferruh Yigit:
> On 7/9/2019 2:11 PM, Thomas Monjalon wrote:
> > The command "make doc-guides-pdf" is failing because
> > there are more than 1500 lines in the file MAINTAINERS
> > which is included in the contributing guide.
> > 
> > We are facing the issue mentioned in this comment:
> > https://github.com/sphinx-doc/sphinx/issues/3099#issuecomment-256440704
> > 
> > Anyway the file MAINTAINERS is mentioned several times in the guide.
> > So the "literalinclude" is removed from the guide to fix the build
> > of the PDF.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Tested-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied

[dpdk-dev] [PATCH] doc: fix pdf build

[Marko Kovacevic]

PDF build was failing in the howto guides
found the weird character causing the issue

Fixes: 6e9270eab112 ("doc: add telemetry how-to")
Cc: ciara.power@intel.com

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
---
 doc/guides/howto/telemetry.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/guides/howto/telemetry.rst b/doc/guides/howto/telemetry.rst
index 3fcb061..00f8f7a 100644
--- a/doc/guides/howto/telemetry.rst
+++ b/doc/guides/howto/telemetry.rst
@@ -29,7 +29,7 @@ formatted in JSON and sent back to the requesting client.
 Pre-requisites
 ~~~~~~~~~~~~~~
 
-* Python ≥ 2.5
+* Python >= 2.5
 
 * Jansson library for JSON serialization
 
-- 
2.9.5

Re: [dpdk-dev] [PATCH] doc: fix pdf build

[Ferruh Yigit]

On 11/2/2018 1:38 PM, Marko Kovacevic wrote:
> PDF build was failing in the howto guides
> found the weird character causing the issue
> 
> Fixes: 6e9270eab112 ("doc: add telemetry how-to")
> Cc: ciara.power@intel.com
> 
> Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>

Tested-by: Ferruh Yigit <ferruh.yigit@intel.com>

Re: [dpdk-dev] [PATCH] doc: fix pdf build

[Mcnamara, John]

> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Friday, November 2, 2018 1:38 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; thomas@monjalon.net;
> Kovacevic, Marko <marko.kovacevic@intel.com>; ciara.power@intel.com
> Subject: [PATCH] doc: fix pdf build
> 
> PDF build was failing in the howto guides found the weird character
> causing the issue

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

--
https://ie.movember.com/mospace/13843119

Re: [dpdk-dev] [PATCH] doc: fix pdf build

[Thomas Monjalon]

02/11/2018 17:31, Mcnamara, John:
> From: Kovacevic, Marko
> > PDF build was failing in the howto guides found the weird character
> > causing the issue
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks

Re: [dpdk-dev] [PATCH] doc: fix pdf build

[Thomas Monjalon]

02/11/2018 14:38, Marko Kovacevic:
> PDF build was failing in the howto guides
> found the weird character causing the issue
[...]
> -* Python ≥ 2.5
> +* Python >= 2.5

I spent some time on it and gave up.
You are my hero :)

Re: [dpdk-dev] [PATCH] doc: fix pdf build

[Kovacevic, Marko]

All appreciations can be shown here Thomas :)
https://mobro.co/13793316

And had help from John :)

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Friday, November 2, 2018 4:44 PM
> To: Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>;
> ciara.power@intel.com
> Subject: Re: [PATCH] doc: fix pdf build
> 
> 02/11/2018 14:38, Marko Kovacevic:
> > PDF build was failing in the howto guides found the weird character
> > causing the issue
> [...]
> > -* Python ≥ 2.5
> > +* Python >= 2.5
> 
> I spent some time on it and gave up.
> You are my hero :)
> 
> 

[dpdk-dev] [PATCH] doc: fix PDF build

[Thomas Monjalon]

The SVG images must be referenced without their extension,
because it is converted to PNG for PDF.

Fixes: 54c4cbb6ccf1 ("doc: add graphics to bbdev guide")

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

diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst
index 426d31f09..9de14443e 100644
--- a/doc/guides/prog_guide/bbdev.rst
+++ b/doc/guides/prog_guide/bbdev.rst
@@ -571,7 +571,7 @@ TB-mode. CB-mode is a reduced version, where only one CB exists:
 
 .. _figure_turbo_tb_encode:
 
-.. figure:: img/turbo_tb_encode.svg
+.. figure:: img/turbo_tb_encode.*
 
     Turbo encoding of Code Blocks in mbuf structure
 
@@ -665,7 +665,7 @@ TB-mode. CB-mode is a reduced version, where only one CB exists:
 
 .. _figure_turbo_tb_decode:
 
-.. figure:: img/turbo_tb_decode.svg
+.. figure:: img/turbo_tb_decode.*
 
     Turbo decoding of Code Blocks in mbuf structure
 
-- 
2.17.1

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

[Mokhtar, Amr]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Wednesday 8 August 2018 22:25
> To: Mokhtar, Amr <amr.mokhtar@intel.com>
> Cc: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Kovacevic,
> Marko <marko.kovacevic@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; dev@dpdk.org
> Subject: [PATCH] doc: fix PDF build
> 
> The SVG images must be referenced without their extension,
> because it is converted to PNG for PDF.
> 
> Fixes: 54c4cbb6ccf1 ("doc: add graphics to bbdev guide")
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---

Acked-by: Amr Mokhtar <amr.mokhtar@intel.com>

Thanks!

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

[Thomas Monjalon]

> > The SVG images must be referenced without their extension,
> > because it is converted to PNG for PDF.
> > 
> > Fixes: 54c4cbb6ccf1 ("doc: add graphics to bbdev guide")
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> 
> Acked-by: Amr Mokhtar <amr.mokhtar@intel.com>
> 
> Thanks!

Applied