]> git.sesse.net Git - ffmpeg/blob - doc/Makefile
print_options: do not generate docs for options without enc or dec flags
[ffmpeg] / doc / Makefile
1 MANPAGES    = $(PROGS-yes:%=doc/%.1)
2 PODPAGES    = $(PROGS-yes:%=doc/%.pod)
3 HTMLPAGES   = $(PROGS-yes:%=doc/%.html)                                 \
4               doc/developer.html                                        \
5               doc/faq.html                                              \
6               doc/fate.html                                             \
7               doc/general.html                                          \
8               doc/git-howto.html                                        \
9               doc/libavfilter.html                                      \
10               doc/nut.html                                              \
11               doc/platform.html                                         \
12
13 DOCS = $(HTMLPAGES) $(MANPAGES) $(PODPAGES)
14
15 all-$(CONFIG_DOC): documentation
16
17 apidoc: doc/doxy/html
18 documentation: $(DOCS)
19
20 TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
21
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
29 doc/%.html: TAG = HTML
30 doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
31         $(Q)$(TEXIDEP)
32         $(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
33
34 doc/%.pod: TAG = POD
35 doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
36         $(Q)$(TEXIDEP)
37         $(M)$(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@
38
39 doc/%.1: TAG = MAN
40 doc/%.1: doc/%.pod $(GENTEXI)
41         $(M)pod2man --section=1 --center=" " --release=" " $< > $@
42
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) $^
47
48 install-progs-$(CONFIG_DOC): install-man
49
50 install-man: $(MANPAGES)
51         $(Q)mkdir -p "$(MANDIR)/man1"
52         $(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"
53
54 uninstall: uninstall-man
55
56 uninstall-man:
57         $(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))
58
59 clean::
60         $(RM) doc/*.html doc/*.pod doc/*.1 $(CLEANSUFFIXES:%=doc/%) doc/avoptions_*.texi
61         $(RM) -r doc/doxy/html
62
63 -include $(wildcard $(DOCS:%=%.d))
64
65 .PHONY: apidoc documentation