[dpdk-dev] [PATCH v2 0/4] doc: Add 'make pdf' target to convert guide docs to pdf
Thomas Monjalon
thomas.monjalon at 6wind.com
Fri Jan 30 21:25:14 CET 2015
Hi John,
2015-01-30 18:13, John McNamara:
> This patch adds support for creating PDF versions of the user guides.
>
> Specifically:
>
> * The Programmer's Guide
> * The Linux Getting Started Guide
> * The FreeBSD Getting Started Guide
> * The Sample Applications User Guide
> * The TestPMD User Guide
> * The Release Notes
>
> The local and online Html documentation is very useful but we have had
> internal and external requests from people who also liked the PDF
> documentation in older releases.
>
> The PDF generation is fully automated and uses the same Sphinx build system
> and RST files used for the Html docs but uses the 'latexpdf' target. In
> addition to the standard Sphinx Python modules it requires the Tex/LaTeX
> toolchain. For best results it requires a TexLive 'Full' installation.
>
> The PDF documents are generated as follows:
>
> make pdf
> # or
> make doc-pdf
>
> The PDFs aren't generated as part of the 'make doc' rule since they can take
> some 1-3 minutes to build and since they have a large toolchain dependency.
>
> V2 Changes:
>
> * Removes config file duplication
> * Converts SVG files to PNG on the fly
> * Splits the patch into distinct mk/doc parts
> * Fixes issues in the RST docs that prevent PDF generation
It seems a lot better.
I still have some comments but I feel we are not far of the simplest code ;)
--
Thomas
More information about the dev
mailing list