From patchwork Mon Feb 2 13:16:04 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John McNamara X-Patchwork-Id: 2912 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 2E6DF376D; Mon, 2 Feb 2015 14:16:14 +0100 (CET) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id E3C232A5E for ; Mon, 2 Feb 2015 14:16:12 +0100 (CET) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga101.fm.intel.com with ESMTP; 02 Feb 2015 05:16:10 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.09,506,1418112000"; d="scan'208";a="671476424" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by fmsmga002.fm.intel.com with ESMTP; 02 Feb 2015 05:16:10 -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 t12DG93g005970; Mon, 2 Feb 2015 13:16:09 GMT Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id t12DG97E027106; Mon, 2 Feb 2015 13:16:09 GMT Received: (from jmcnam2x@localhost) by sivswdev02.ir.intel.com with id t12DG9E1027102; Mon, 2 Feb 2015 13:16:09 GMT From: John McNamara To: dev@dpdk.org Date: Mon, 2 Feb 2015 13:16:04 +0000 Message-Id: <1422882967-27060-2-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 In-Reply-To: <1422882967-27060-1-git-send-email-john.mcnamara@intel.com> References: <1421255657-19521-1-git-send-email-john.mcnamara@intel.com> <1422882967-27060-1-git-send-email-john.mcnamara@intel.com> Subject: [dpdk-dev] [PATCH v3 1/4] mk: Add 'make doc-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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Added make system support for building PDF versions of the guides. Requires Python Sphinx and TexLive Full. Signed-off-by: John McNamara --- mk/rte.sdkdoc.mk | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 files changed, 43 insertions(+), 1 deletions(-) diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk index dabc0d6..41e9391 100644 --- a/mk/rte.sdkdoc.mk +++ b/mk/rte.sdkdoc.mk @@ -37,13 +37,24 @@ endif endif RTE_SPHINX_BUILD = sphinx-build +RTE_PDFLATEX_VERBOSE := --interaction=nonstopmode + ifndef V RTE_SPHINX_VERBOSE := -q +RTE_PDFLATEX_VERBOSE := --interaction=batchmode +RTE_INKSCAPE_VERBOSE := > /dev/null 2>&1 endif ifeq '$V' '0' RTE_SPHINX_VERBOSE := -q +RTE_PDFLATEX_VERBOSE := --interaction=batchmode +RTE_INKSCAPE_VERBOSE := > /dev/null 2>&1 endif +RTE_GUIDE_PDFS := $(filter %/, $(wildcard $(RTE_SDK)/doc/guides/*/)) +RTE_GUIDE_PDFS := $(RTE_GUIDE_PDFS:$(RTE_SDK)/doc/guides%=$(RTE_OUTPUT)/doc/latex/guides%) +RTE_GUIDE_PDFS := $(RTE_GUIDE_PDFS:%/=%.pdf) +RTE_DEFAULT_DPI ?= 300 + .PHONY: help help: @cat $(RTE_SDK)/doc/build-sdk-quick.txt @@ -53,7 +64,7 @@ help: all: api-html guides-html .PHONY: clean -clean: api-html-clean guides-html-clean +clean: api-html-clean guides-html-clean guides-latex-clean .PHONY: api-html api-html: api-html-clean @@ -83,3 +94,34 @@ guides-%: @echo 'sphinx for guides...' $(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \ -c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides $(RTE_OUTPUT)/doc/$*/guides + + +pdf: $(RTE_GUIDE_PDFS) + +.SECONDEXPANSION: +# Use wildcard expansion to avoid * expansion issue with make 3.82. +$(RTE_OUTPUT)/doc/latex/guides/%.pdf: $$(wildcard $(RTE_SDK)/doc/guides/%/*.rst) + @echo 'creating' $* 'pdf ...' + + @# Generate the latex files. + $(Q)$(RTE_SPHINX_BUILD) -b latex $(RTE_SPHINX_VERBOSE) \ + -c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides/$* \ + $(RTE_OUTPUT)/doc/latex/guides/$* + + @# Convert the svg files to png for pdflatex. + $(eval svg_files=$(notdir $(wildcard $(RTE_SDK)/doc/guides/$*/img/*.svg))) + $(Q)for svg in $(svg_files:.svg=); do \ + inkscape -d $(RTE_DEFAULT_DPI) -D -b ffffff \ + -f $(RTE_SDK)/doc/guides/$*/img/$$svg.svg \ + -e $(RTE_OUTPUT)/doc/latex/guides/$*/$$svg.png \ + $(RTE_INKSCAPE_VERBOSE); \ + done + + @# Change the svg image includes to png in the latex docs. + $(Q)sed -i.bak 's/\.svg/.png/g' $(RTE_OUTPUT)/doc/latex/guides/$*/*.tex + + @# Convert latex to pdf (from .tex dir to avoid image include issues). + $(Q)cd $(RTE_OUTPUT)/doc/latex/guides/$*; \ + pdflatex $(RTE_PDFLATEX_VERBOSE) dpdk_doc.tex + + $(Q)mv $(RTE_OUTPUT)/doc/latex/guides/$*/dpdk_doc.pdf $@