From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCH v2 0/4] doc: Add 'make pdf' target to convert guide docs to pdf Date: Fri, 30 Jan 2015 21:25:14 +0100 Message-ID: <8837708.92oJ92tvuU@xps13> References: <1421255657-19521-1-git-send-email-john.mcnamara@intel.com> <1422641608-8514-1-git-send-email-john.mcnamara@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7Bit Cc: dev-VfR2kkLFssw@public.gmane.org To: John McNamara Return-path: In-Reply-To: <1422641608-8514-1-git-send-email-john.mcnamara-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces-VfR2kkLFssw@public.gmane.org Sender: "dev" 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