a yum_install function
[nodemanager.git] / doc / Makefile
1 #
2 # (Re)builds API documentation
3 #
4 # Mark Huang <mlhuang@cs.princeton.edu>
5 # Copyright (C) 2006 The Trustees of Princeton University
6 #
7 # $Id: Makefile 5574 2007-10-25 20:33:17Z thierry $
8 #
9
10 all: NMAPI.html
11
12 # XML - as opposed to SGML - requires an identifier - see 
13 # http://www.docbook.org/tdg/en/html/appb.html
14 # and, openjade opens http connections when using the official URL 
15 # as an identifier; this is slow, and sometimes fails and breaks the build
16
17 # locating locally installed docbook43 dtd - fedora-specific
18 remote-docbook-43 = http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd
19 local-docbook-43 = $(wildcard /usr/share/sgml/docbook/xml-dtd-4.3-*/docbookx.dtd)
20 docbook-43=$(if $(local-docbook-43),$(local-docbook-43),$(remote-docbook-43))
21
22 NMAPI.xml: NMAPI.xml.in
23         $(if $(local-docbook-43), \
24         echo Using locally installed DTD $(local-docbook-43), \
25         echo WARNING - could not locate local DTD - using remote $(remote-docbook-43))
26         sed -e s,@DOCBOOK-43@,$(docbook-43), $< > $@
27
28 .NMAPI.xml.valid: Methods.xml
29
30 NM_SOURCES = ../api_calls.py
31
32 # path needs to mention PLCAPI/doc (for DocBook) and PLCAPI/ (for PLC.Parameter)
33 Methods.xml: DocBookLocal.py $(NM_SOURCES)
34         PYTHONPATH=..:../../plcapi:../../plcapi/doc ./DocBookLocal.py > $@
35
36 #
37 # Documentation
38 #
39
40 # Validate the XML
41 .%.xml.valid: %.xml
42         xmllint --valid --output $@ $<
43
44 # Remove the temporary output file after compilation
45 .SECONDARY: .%.xml.valid
46
47 # Compile it into other formats
48 FORMATS := dvi html man ps pdf rtf tex texi txt
49
50 DOCBOOK2FLAGS := -V biblio-number=1
51
52 define docbook2
53 %.$(1): %.xml .%.xml.valid
54         docbook2$(1) --nochunks $$(DOCBOOK2FLAGS) $$<
55 endef
56
57 $(foreach format,$(FORMATS),$(eval $(call docbook2,$(format))))
58
59 clean:
60         rm -f $(patsubst %,*.%,$(FORMATS)) .*.xml.valid Methods.xml
61
62 .PHONY: clean all