DPDK patches and discussions
 help / color / mirror / Atom feed
From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v2 1/4] mk: Add 'make doc-pdf' target to convert guide docs to pdf
Date: Fri, 30 Jan 2015 18:13:25 +0000	[thread overview]
Message-ID: <1422641608-8514-2-git-send-email-john.mcnamara@intel.com> (raw)
In-Reply-To: <1422641608-8514-1-git-send-email-john.mcnamara@intel.com>

Added make system support for building PDF versions of
the guides. Requires Python Sphinx and TexLive Full.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 mk/rte.sdkdoc.mk  |   33 ++++++++++++++++++++++++++++++++-
 mk/rte.sdkroot.mk |    3 ++-
 2 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index dabc0d6..fb90d41 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -39,11 +39,15 @@ endif
 RTE_SPHINX_BUILD = sphinx-build
 ifndef V
 RTE_SPHINX_VERBOSE := -q
+RTE_PDFLATEX_VERBOSE := > /dev/null 2>&1
 endif
 ifeq '$V' '0'
 RTE_SPHINX_VERBOSE := -q
+RTE_PDFLATEX_VERBOSE := > /dev/null 2>&1
 endif
 
+DEFAULT_DPI ?= 300
+
 .PHONY: help
 help:
 	@cat $(RTE_SDK)/doc/build-sdk-quick.txt
@@ -53,7 +57,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 +87,30 @@ 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: pdf-rel_notes pdf-linux_gsg pdf-freebsd_gsg pdf-prog_guide \
+	pdf-sample_app_ug pdf-testpmd_app_ug
+
+pdf-%:
+	@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.
+	$(eval svg_files=$(notdir $(wildcard $(RTE_SDK)/doc/guides/$*/img/*.svg)))
+	$(eval svg_files=$(patsubst %.svg, %, $(svg_files)))
+	@for svg in $(svg_files); do \
+		inkscape -d $(DEFAULT_DPI) -D -b ffffff  \
+			-f $(RTE_SDK)/doc/guides/$*/img/$$svg.svg \
+			-e $(RTE_OUTPUT)/doc/latex/guides/$*/$$svg.png \
+				$(RTE_PDFLATEX_VERBOSE); \
+	done
+
+        # Change the svg image includes to png in the latex docs.
+	$(Q)sed -i 's/\.svg/.png/g' $(RTE_OUTPUT)/doc/latex/guides/$*/*.tex
+
+        # Convert the latex to pdf.
+	$(Q)$(MAKE) -C $(RTE_OUTPUT)/doc/latex/guides/$* \
+		all-pdf $(RTE_PDFLATEX_VERBOSE)
diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk
index e8423b0..68931bb 100644
--- a/mk/rte.sdkroot.mk
+++ b/mk/rte.sdkroot.mk
@@ -101,9 +101,10 @@ testall:
 install uninstall:
 	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkinstall.mk $@
 
-.PHONY: doc help
+.PHONY: doc help pdf
 doc: doc-all
 help: doc-help
+pdf: doc-pdf
 doc-%:
 	$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkdoc.mk $*
 
-- 
1.7.4.1

  reply	other threads:[~2015-01-30 18:14 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-14 17:14 [dpdk-dev] [PATCH RFC 0/1] Add 'make pdf' " John McNamara
2015-01-14 17:14 ` [dpdk-dev] [PATCH 1/2] doc: " John McNamara
2015-01-30 18:13 ` [dpdk-dev] [PATCH v2 0/4] " John McNamara
2015-01-30 18:13   ` John McNamara [this message]
2015-01-30 20:52     ` [dpdk-dev] [PATCH v2 1/4] mk: Add 'make doc-pdf' " Thomas Monjalon
     [not found]       ` <B27915DBBA3421428155699D51E4CFE2EAC4D2@IRSMSX103.ger.corp.intel.com>
     [not found]         ` <2564393.TY2qeNvaqR@xps13>
2015-02-03 13:24           ` Mcnamara, John
2015-01-30 18:13   ` [dpdk-dev] [PATCH v2 2/4] doc: Add Sphinx config to build pdf version of guides John McNamara
2015-01-30 21:03     ` Thomas Monjalon
2015-01-30 18:13   ` [dpdk-dev] [PATCH v2 3/4] doc: Fix encoding of (r) character John McNamara
2015-01-30 18:13   ` [dpdk-dev] [PATCH v2 4/4] doc: Refactored split cell formatting in one table John McNamara
2015-01-30 21:05     ` Thomas Monjalon
2015-01-30 20:25   ` [dpdk-dev] [PATCH v2 0/4] doc: Add 'make pdf' target to convert guide docs to pdf Thomas Monjalon
     [not found] ` <1422882967-27060-1-git-send-email-john.mcnamara@intel.com>
     [not found]   ` <1422882967-27060-3-git-send-email-john.mcnamara@intel.com>
2015-02-03 10:30     ` [dpdk-dev] [PATCH v3 2/4] doc: Add Sphinx config to build pdf version of guides Iremonger, Bernard
2015-02-03 14:11 ` [dpdk-dev] [PATCH v4 0/5] doc: Add 'make pdf' target to convert guide docs to pdf John McNamara
2015-02-03 14:11   ` [dpdk-dev] [PATCH v4 1/5] mk: Add 'make doc-pdf' " John McNamara
2015-02-16 12:19     ` Iremonger, Bernard
2015-02-16 12:55       ` Mcnamara, John
2015-02-16 14:16       ` Iremonger, Bernard
2015-02-03 14:11   ` [dpdk-dev] [PATCH v4 2/5] doc: Add Sphinx config to build pdf version of guides John McNamara
2015-02-16 14:20     ` Iremonger, Bernard
2015-02-03 14:11   ` [dpdk-dev] [PATCH v4 3/5] doc: Fix encoding of (r) character John McNamara
2015-02-13 14:29     ` Iremonger, Bernard
2015-02-13 15:59       ` Mcnamara, John
2015-02-13 16:42         ` Iremonger, Bernard
2015-02-16 14:22     ` Iremonger, Bernard
2015-02-03 14:11   ` [dpdk-dev] [PATCH v4 4/5] doc: Refactored split cell formatting in one table John McNamara
2015-02-16 14:23     ` Iremonger, Bernard
2015-02-03 14:11   ` [dpdk-dev] [PATCH v4 5/5] doc: Convert image extensions to wildcard John McNamara
2015-02-16 12:09     ` Iremonger, Bernard
2015-02-16 12:43       ` Mcnamara, John
2015-02-16 14:25     ` Iremonger, Bernard
2015-03-19 11:23   ` [dpdk-dev] [PATCH v5 0/7] add doc-guides-pdf target Thomas Monjalon
2015-03-19 11:23     ` [dpdk-dev] [PATCH v5 1/7] doc: fix encoding of (r) character Thomas Monjalon
2015-03-19 11:23     ` [dpdk-dev] [PATCH v5 2/7] doc: refactor split cell formatting in table Thomas Monjalon
2015-03-19 11:23     ` [dpdk-dev] [PATCH v5 3/7] doc: convert image extensions to wildcard Thomas Monjalon
2015-03-19 11:23     ` [dpdk-dev] [PATCH v5 4/7] doc: add pdf output Thomas Monjalon
2015-03-19 11:23     ` [dpdk-dev] [PATCH v5 5/7] doc: fix version for python 3 Thomas Monjalon
2015-03-19 11:23     ` [dpdk-dev] [PATCH v5 6/7] doc: tune pdf fonts Thomas Monjalon
2015-03-19 11:23     ` [dpdk-dev] [PATCH v5 7/7] doc: remove blank pages in pdf Thomas Monjalon
2015-03-19 13:47     ` [dpdk-dev] [PATCH v5 0/7] add doc-guides-pdf target Mcnamara, John
2015-03-19 17:04       ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1422641608-8514-2-git-send-email-john.mcnamara@intel.com \
    --to=john.mcnamara@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).