From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <thomas.monjalon@6wind.com>
Received: from mail-wg0-f45.google.com (mail-wg0-f45.google.com [74.125.82.45])
by dpdk.org (Postfix) with ESMTP id 04310568F
for <dev@dpdk.org>; Thu, 19 Mar 2015 12:24:05 +0100 (CET)
Received: by wggv3 with SMTP id v3so59579284wgg.1
for <dev@dpdk.org>; Thu, 19 Mar 2015 04:24:05 -0700 (PDT)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20130820;
h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
:references;
bh=+0JSWnckEbfYSiFvT1Q+SmVeTW+sLsdlyFGGWog7xzw=;
b=ZLxxmEzO3dCB6V6QRu+q4oiKGV88CTKkC30QmfFsEH3EBqU3oscUk27ZVXIbCvoqUr
MCwPWBhwTWDTLcrvSRstyRmQv61PVMt2eWD9+u4B5zg/NZtXF0yfY6quH+bQkTZYronO
2ijsR71PJaGDk5jq1iV+DJkr11sqllBXfEbzTON/vNT4684l5SZeP4rAqfdjvpBMvmmu
R1bjYWeDW2j2lXGtFQ1M2foHER8StXZac0IlumaHhdqGoN6+ZEBCsz153MmjijzpEEs5
IZJbAWPU14ztJxir8oPyMMXL2lRUDaru9IYjNoEARN31REq5vwpa3OFpKvmROZHdcb5p
rTdw==
X-Gm-Message-State: ALoCoQmYJzQaBHrY2JO2Tk8VsxSXqnJBqbfgQjK1q3YfVa0G8Absw4vD1CgvZ/8e/0i566Jf1BN9
X-Received: by 10.194.193.99 with SMTP id hn3mr152511180wjc.148.1426764245580;
Thu, 19 Mar 2015 04:24:05 -0700 (PDT)
Received: from localhost.localdomain (136-92-190-109.dsl.ovh.fr.
[109.190.92.136])
by mx.google.com with ESMTPSA id y14sm1537682wjr.39.2015.03.19.04.24.04
(version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128);
Thu, 19 Mar 2015 04:24:04 -0700 (PDT)
From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: john.mcnamara@intel.com
Date: Thu, 19 Mar 2015 12:23:17 +0100
Message-Id: <1426764204-3882-1-git-send-email-thomas.monjalon@6wind.com>
X-Mailer: git-send-email 2.2.2
In-Reply-To: <1422972678-7982-1-git-send-email-john.mcnamara@intel.com>
References: <1422972678-7982-1-git-send-email-john.mcnamara@intel.com>
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v5 0/7] add doc-guides-pdf target
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Thu, 19 Mar 2015 11:24:06 -0000
First versions were written by John. I suggest this v5 for last changes.
This patchset 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 doc
# or more specifically
make doc-guides-pdf
If you desire only HTML doc, use
make doc-guides-html doc-api-html
V5 Changes:
* Build PDF with HTML in generic "doc" target (not so long to build with -j)
* Rename rules and build directory from latex to pdf
* Split basic PDF build and tuning patches
* Refactor rte.sdkdoc.mk changes to be aligned with HTML rules
* Fix for Python 3
* Remove blank pages
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):
doc: fix encoding of (r) character
doc: refactor split cell formatting in table
doc: convert image extensions to wildcard
doc: add pdf output
doc: tune pdf fonts
Thomas Monjalon (2):
doc: fix version for python 3
doc: remove blank pages in pdf
doc/guides/conf.py | 47 +++++++++++++++++++++-
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 | 46 ++++++++++++++++++---
37 files changed, 214 insertions(+), 125 deletions(-)