[libav.git] / doc / Makefile

MANPAGES    = $(PROGS-yes:%=doc/%.1)
PODPAGES    = $(PROGS-yes:%=doc/%.pod)
HTMLPAGES   = $(PROGS-yes:%=doc/%.html)                                 \
              doc/developer.html                                        \
              doc/faq.html                                              \
              doc/fate.html                                             \
              doc/general.html                                          \
              doc/git-howto.html                                        \
              doc/libavfilter.html                                      \
              doc/nut.html                                              \
              doc/platform.html                                         \

DOCS = $(HTMLPAGES) $(MANPAGES) $(PODPAGES)

all-$(CONFIG_DOC): documentation

apidoc: doc/doxy/html
documentation: $(DOCS)

TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)

GENTEXI  = format codec
GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)

$(GENTEXI): TAG = GENTEXI
$(GENTEXI): doc/avoptions_%.texi: doc/print_options
	$(M)doc/print_options $* > $@

doc/%.html: TAG = HTML
doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
	$(Q)$(TEXIDEP)
	$(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<

doc/%.pod: TAG = POD
doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
	$(Q)$(TEXIDEP)
	$(M)$(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@

doc/%.1: TAG = MAN
doc/%.1: doc/%.pod $(GENTEXI)
	$(M)pod2man --section=1 --center=" " --release=" " $< > $@

$(DOCS) doc/doxy/html: | doc/

doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(INSTHEADERS)
	$(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $^

install-progs-$(CONFIG_DOC): install-doc install-man

install-doc: $(HTMLPAGES)
	$(Q)mkdir -p "$(DOCDIR)"
	$(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"

install-man: $(MANPAGES)
	$(Q)mkdir -p "$(MANDIR)/man1"
	$(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"

uninstall: uninstall-doc uninstall-man

uninstall-doc:
	$(RM) -r "$(DOCDIR)"

uninstall-man:
	$(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))

clean::
	$(RM) doc/*.html doc/*.pod doc/*.1 $(CLEANSUFFIXES:%=doc/%) doc/avoptions_*.texi
	$(RM) -r doc/doxy/html

-include $(wildcard $(DOCS:%=%.d))

.PHONY: apidoc documentation
Commit	Line	Data
f87b03b5 MR	1	MANPAGES = $(PROGS-yes:%=doc/%.1)
f87b03b5 MR	2	PODPAGES = $(PROGS-yes:%=doc/%.pod)
47b20a1d DB	3	HTMLPAGES = $(PROGS-yes:%=doc/%.html) \
	4	doc/developer.html \
	5	doc/faq.html \
1ebbdda1	6	doc/fate.html \
47b20a1d	7	doc/general.html \
2f017d97	8	doc/git-howto.html \
47b20a1d	9	doc/libavfilter.html \
175d0d94	10	doc/nut.html \
1de6e14e	11	doc/platform.html \
f87b03b5	12
47b20a1d	13	DOCS = $(HTMLPAGES) $(MANPAGES) $(PODPAGES)
f87b03b5 MR	14
	15	all-$(CONFIG_DOC): documentation
	16
b3fab1f2	17	apidoc: doc/doxy/html
f87b03b5 MR	18	documentation: $(DOCS)
	19
	20	TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
	21
0d0b81f9 AK	22	GENTEXI = format codec
	23	GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
	24
	25	$(GENTEXI): TAG = GENTEXI
	26	$(GENTEXI): doc/avoptions_%.texi: doc/print_options
	27	$(M)doc/print_options $* > $@
	28
f87b03b5	29	doc/%.html: TAG = HTML
0d0b81f9	30	doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
f87b03b5	31	$(Q)$(TEXIDEP)
2ac3df85	32	$(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
f87b03b5 MR	33
f87b03b5 MR	34	doc/%.pod: TAG = POD
7a95afe4	35	doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
f87b03b5	36	$(Q)$(TEXIDEP)
2ac3df85	37	$(M)$(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@
f87b03b5 MR	38
f87b03b5 MR	39	doc/%.1: TAG = MAN
0d0b81f9	40	doc/%.1: doc/%.pod $(GENTEXI)
f87b03b5 MR	41	$(M)pod2man --section=1 --center=" " --release=" " $< > $@
f87b03b5 MR	42
b3fab1f2 JG	43	$(DOCS) doc/doxy/html: \| doc/
	44
	45	doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(INSTHEADERS)
	46	$(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $^
5e27ec28	47
f4ca970d VG	48	install-progs-$(CONFIG_DOC): install-doc install-man
	49
	50	install-doc: $(HTMLPAGES)
	51	$(Q)mkdir -p "$(DOCDIR)"
	52	$(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
f87b03b5 MR	53
	54	install-man: $(MANPAGES)
	55	$(Q)mkdir -p "$(MANDIR)/man1"
	56	$(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"
	57
f4ca970d VG	58	uninstall: uninstall-doc uninstall-man
	59
	60	uninstall-doc:
	61	$(RM) -r "$(DOCDIR)"
f87b03b5 MR	62
	63	uninstall-man:
	64	$(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))
	65
	66	clean::
0d0b81f9	67	$(RM) doc/.html doc/.pod doc/.1 $(CLEANSUFFIXES:%=doc/%) doc/avoptions_.texi
b3fab1f2	68	$(RM) -r doc/doxy/html
f87b03b5 MR	69
	70	-include $(wildcard $(DOCS:%=%.d))
	71
b3fab1f2	72	.PHONY: apidoc documentation