From mboxrd@z Thu Jan 1 00:00:00 1970 From: John McNamara Subject: [PATCH v3 0/4] doc: Add 'make pdf' target to convert guide docs to pdf Date: Mon, 2 Feb 2015 13:16:03 +0000 Message-ID: <1422882967-27060-1-git-send-email-john.mcnamara@intel.com> References: <1421255657-19521-1-git-send-email-john.mcnamara@intel.com> To: dev-VfR2kkLFssw@public.gmane.org Return-path: In-Reply-To: <1421255657-19521-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" 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. V3 Changes: * Removed sub-directory config.py files and replaced them with metadata in the main doc/guides/conf.py file and a more generic make rule. * Added *.pdf targets with *.rst dependencies. * Call pdflatex directly (instead of from Sphinx) to control the verbosity of the output. 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 John McNamara (4): mk: Add 'make doc-pdf' target to convert guide docs to pdf doc: Add Sphinx config to build pdf version of guides doc: Fix encoding of (r) character doc: Refactored split cell formatting in one table doc/guides/conf.py | 44 ++++++++++++++++++++++++++- doc/guides/rel_notes/supported_features.rst | 2 +- doc/guides/sample_app_ug/test_pipeline.rst | 32 +++++++++++++------ mk/rte.sdkdoc.mk | 44 ++++++++++++++++++++++++++- 4 files changed, 109 insertions(+), 13 deletions(-) -- 1.7.4.1