summaryrefslogtreecommitdiff
path: root/mk/rte.doc.mk
blob: f5d6e937f596321850c50c1967b1ae01279cf969 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
#   BSD LICENSE
# 
#   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
#   All rights reserved.
# 
#   Redistribution and use in source and binary forms, with or without 
#   modification, are permitted provided that the following conditions 
#   are met:
# 
#     * Redistributions of source code must retain the above copyright 
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright 
#       notice, this list of conditions and the following disclaimer in 
#       the documentation and/or other materials provided with the 
#       distribution.
#     * Neither the name of Intel Corporation nor the names of its 
#       contributors may be used to endorse or promote products derived 
#       from this software without specific prior written permission.
# 
#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
#   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
#   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
#   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
#   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
#   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
#   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
#   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
#   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# 

DEFAULT_DPI ?= 300

ifeq ($(BASEDOCDIR),)
$(error "must be called from RTE root Makefile")
endif
ifeq ($(DOCDIR),)
$(error "must be called from RTE root Makefile")
endif

VPATH = $(abspath $(BASEDOCDIR)/$(DOCDIR))

pngfiles = $(patsubst %.svg,%.png,$(SVG))
pdfimgfiles = $(patsubst %.svg,%.pdf,$(SVG))
pdffiles = $(patsubst %.rst,%.pdf,$(RST))

.PHONY: all doc clean

compare = $(strip $(subst $(1),,$(2)) $(subst $(2),,$(1)))
dirname = $(patsubst %/,%,$(dir $1))

# windows only: this is needed for native programs that do not handle
# unix-like paths on win32
ifdef COMSPEC
winpath = "$(shell cygpath --windows $(abspath $(1)))"
else
winpath = $(1)
endif

all doc: $(pngfiles) $(pdffiles) $(DIRS)
	@true

pdfdoc: $(pngfiles) $(pdffiles) $(DIRS)
	@true

doxydoc: $(pdfimgfiles) $(DIRS)
	@true

.PHONY: $(DIRS)
$(DIRS):
	@[ -d $(CURDIR)/$@ ] || mkdir -p $(CURDIR)/$@
	$(Q)$(MAKE) DOCDIR=$(DOCDIR)/$@ BASEDOCDIR=$(BASEDOCDIR)/.. \
		-f $(RTE_SDK)/doc/$(DOCDIR)/$@/Makefile -C $(CURDIR)/$@ $(MAKECMDGOALS)

%.png: %.svg
	@echo "  INKSCAPE $(@)"
	$(Q)inkscape -d $(DEFAULT_DPI) -D -b ffffff -y 1.0 -e $(call winpath,$(@)) $(call winpath,$(<))

%.pdf: %.svg
	@echo "  INKSCAPE $(@)"
	$(Q)inkscape -d $(DEFAULT_DPI) -D -b ffffff -y 1.0 -A $(call winpath,$(@)) $(call winpath,$(<))

.SECONDEXPANSION:
$(foreach f,$(RST),$(eval DEP_$(f:%.rst=%.html) = $(DEP_$(f))))
%.html: %.rst $$(DEP_$$@)
	@echo "  RST2HTML $(@)"
	$(Q)mkdir -p `dirname $(@)` ; \
	python $(BASEDOCDIR)/gen/gen-common.py html $(BASEDOCDIR) > $(BASEDOCDIR)/gen/rte.rst ; \
	python $(BASEDOCDIR)/html/rst2html-highlight.py --link-stylesheet \
		--stylesheet-path=$(BASEDOCDIR)/html/rte.css \
		--strip-comments< $(<) > $(@) ; \

# there is a bug in rst2pdf (issue 311): replacement of DSTDIR is not
# what we expect: we should not have to add doc/
ifdef COMSPEC
WORKAROUND_PATH=$(BASEDOCDIR)
else
WORKAROUND_PATH=$(BASEDOCDIR)/doc
endif

.SECONDEXPANSION:
$(foreach f,$(RST),$(eval DEP_$(f:%.rst=%.pdf) = $(DEP_$(f))))
%.pdf: %.rst $$(DEP_$$@)
	@echo "  RST2PDF $(@)"
	$(Q)mkdir -p `dirname $(@)` ; \
	python $(BASEDOCDIR)/gen/gen-common.py pdf $(BASEDOCDIR) > $(BASEDOCDIR)/gen/rte.rst ; \
	rst2pdf -s $(BASEDOCDIR)/pdf/rte-stylesheet.json \
		--default-dpi=300 < $(<) > $(@)

CLEANDIRS = $(addsuffix _clean,$(DIRS))

docclean clean: $(CLEANDIRS)
	@rm -f $(htmlfiles) $(pdffiles) $(pngfiles) $(pdfimgfiles) $(BASEDOCDIR)/gen/rte.rst

%_clean:
	@if [ -f $(RTE_SDK)/doc/$(DOCDIR)/$*/Makefile -a -d $(CURDIR)/$* ]; then \
		$(MAKE) DOCDIR=$(DOCDIR)/$* BASEDOCDIR=$(BASEDOCDIR)/.. \
		-f $(RTE_SDK)/doc/$(DOCDIR)/$*/Makefile -C $(CURDIR)/$* clean ; \
	fi

.NOTPARALLEL: