From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 1C3409AC9 for ; Tue, 3 Feb 2015 15:11:27 +0100 (CET) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP; 03 Feb 2015 06:11:22 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.09,513,1418112000"; d="scan'208";a="521861452" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga003.jf.intel.com with ESMTP; 03 Feb 2015 06:03:47 -0800 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t13EBLkF015568; Tue, 3 Feb 2015 14:11:21 GMT Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id t13EBL4j008020; Tue, 3 Feb 2015 14:11:21 GMT Received: (from jmcnam2x@localhost) by sivswdev02.ir.intel.com with id t13EBKDR008016; Tue, 3 Feb 2015 14:11:20 GMT From: John McNamara To: dev@dpdk.org Date: Tue, 3 Feb 2015 14:11:13 +0000 Message-Id: <1422972678-7982-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 In-Reply-To: <1421255657-19521-1-git-send-email-john.mcnamara@intel.com> References: <1421255657-19521-1-git-send-email-john.mcnamara@intel.com> Subject: [dpdk-dev] [PATCH v4 0/5] doc: Add 'make pdf' target to convert guide docs to pdf X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 03 Feb 2015 14:11:28 -0000 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. V4 Changes: * Changed RST image types to wildcard to allow Sphinx to decide the appropriate type. * Changed back to calling Sphinx generated makefile to ensure that the pdf files are created by Sphinx make rules. V3 Changes: * Remove 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 (5): 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: Convert image extensions to wildcard doc/guides/conf.py | 48 ++++++++++++++++++- doc/guides/prog_guide/env_abstraction_layer.rst | 2 +- .../prog_guide/i40e_ixgbe_igb_virt_func_drv.rst | 8 ++-- .../intel_dpdk_xen_based_packet_switch_sol.rst | 6 +- doc/guides/prog_guide/ivshmem_lib.rst | 2 +- doc/guides/prog_guide/kernel_nic_interface.rst | 8 ++-- .../libpcap_ring_based_poll_mode_drv.rst | 2 +- .../prog_guide/link_bonding_poll_mode_drv_lib.rst | 14 +++--- doc/guides/prog_guide/lpm6_lib.rst | 2 +- doc/guides/prog_guide/lpm_lib.rst | 2 +- doc/guides/prog_guide/malloc_lib.rst | 2 +- doc/guides/prog_guide/mbuf_lib.rst | 4 +- doc/guides/prog_guide/mempool_lib.rst | 6 +- doc/guides/prog_guide/multi_proc_support.rst | 2 +- doc/guides/prog_guide/overview.rst | 2 +- doc/guides/prog_guide/packet_distrib_lib.rst | 4 +- doc/guides/prog_guide/packet_framework.rst | 14 +++--- .../poll_mode_drv_emulated_virtio_nic.rst | 6 +- .../poll_mode_drv_paravirtual_vmxnets_nic.rst | 6 +- doc/guides/prog_guide/qos_framework.rst | 36 +++++++------- doc/guides/prog_guide/ring_lib.rst | 28 ++++++------ doc/guides/rel_notes/supported_features.rst | 2 +- doc/guides/sample_app_ug/dist_app.rst | 4 +- doc/guides/sample_app_ug/exception_path.rst | 2 +- doc/guides/sample_app_ug/intel_quickassist.rst | 2 +- doc/guides/sample_app_ug/kernel_nic_interface.rst | 4 +- .../sample_app_ug/l2_forward_real_virtual.rst | 4 +- .../sample_app_ug/l3_forward_access_ctrl.rst | 4 +- doc/guides/sample_app_ug/load_balancer.rst | 2 +- doc/guides/sample_app_ug/multi_process.rst | 8 ++-- doc/guides/sample_app_ug/qos_scheduler.rst | 2 +- doc/guides/sample_app_ug/quota_watermark.rst | 6 +- doc/guides/sample_app_ug/test_pipeline.rst | 34 +++++++++----- doc/guides/sample_app_ug/vhost.rst | 10 ++-- doc/guides/sample_app_ug/vm_power_management.rst | 4 +- doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst | 2 +- mk/rte.sdkdoc.mk | 43 +++++++++++++++++- 37 files changed, 216 insertions(+), 121 deletions(-) -- 1.7.4.1