From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <jmcnam2x@ecsmtp.ir.intel.com>
Received: from mga11.intel.com (mga11.intel.com [192.55.52.93])
by dpdk.org (Postfix) with ESMTP id D68D82E8D
for <dev@dpdk.org>; Fri, 30 Jan 2015 19:13:42 +0100 (CET)
Received: from fmsmga001.fm.intel.com ([10.253.24.23])
by fmsmga102.fm.intel.com with ESMTP; 30 Jan 2015 10:13:40 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.09,492,1418112000"; d="scan'208";a="659332718"
Received: from irvmail001.ir.intel.com ([163.33.26.43])
by fmsmga001.fm.intel.com with ESMTP; 30 Jan 2015 10:13:41 -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
t0UIDdPK000935; Fri, 30 Jan 2015 18:13:39 GMT
Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1])
by sivswdev02.ir.intel.com with ESMTP id t0UIDdFt008560;
Fri, 30 Jan 2015 18:13:39 GMT
Received: (from jmcnam2x@localhost)
by sivswdev02.ir.intel.com with id t0UIDdlK008556;
Fri, 30 Jan 2015 18:13:39 GMT
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Date: Fri, 30 Jan 2015 18:13:24 +0000
Message-Id: <1422641608-8514-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 v2 0/4] 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 <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: Fri, 30 Jan 2015 18:13:43 -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.
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 | 51 ++++++++++++++++++++++++--
doc/guides/freebsd_gsg/conf.py | 41 +++++++++++++++++++++
doc/guides/linux_gsg/conf.py | 41 +++++++++++++++++++++
doc/guides/prog_guide/conf.py | 41 +++++++++++++++++++++
doc/guides/rel_notes/conf.py | 41 +++++++++++++++++++++
doc/guides/rel_notes/supported_features.rst | 2 +-
doc/guides/sample_app_ug/conf.py | 41 +++++++++++++++++++++
doc/guides/sample_app_ug/test_pipeline.rst | 32 +++++++++++-----
doc/guides/testpmd_app_ug/conf.py | 41 +++++++++++++++++++++
mk/rte.sdkdoc.mk | 33 +++++++++++++++++-
mk/rte.sdkroot.mk | 3 +-
11 files changed, 350 insertions(+), 17 deletions(-)
create mode 100644 doc/guides/freebsd_gsg/conf.py
create mode 100644 doc/guides/linux_gsg/conf.py
create mode 100644 doc/guides/prog_guide/conf.py
create mode 100644 doc/guides/rel_notes/conf.py
create mode 100644 doc/guides/sample_app_ug/conf.py
create mode 100644 doc/guides/testpmd_app_ug/conf.py
--
1.7.4.1