1 ALLMANPAGES = $(AVBASENAMES:%=%.1)
2 MANPAGES = $(AVPROGS-yes:%=doc/%.1)
3 PODPAGES = $(AVPROGS-yes:%=doc/%.pod)
4 HTMLPAGES = $(AVPROGS-yes:%=doc/%.html) \
10 doc/libavfilter.html \
14 DOCS-$(CONFIG_POD2MAN) += $(MANPAGES) $(PODPAGES)
15 DOCS-$(CONFIG_TEXI2HTML) += $(HTMLPAGES)
18 DOC_EXAMPLES-$(CONFIG_AVCODEC_EXAMPLE) += avcodec
19 DOC_EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE) += filter_audio
20 DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE) += metadata
21 DOC_EXAMPLES-$(CONFIG_OUTPUT_EXAMPLE) += output
22 DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE) += transcode_aac
23 ALL_DOC_EXAMPLES = avcodec filter_audio metadata output transcode_aac
25 DOC_EXAMPLES := $(DOC_EXAMPLES-yes:%=doc/examples/%$(EXESUF))
26 ALL_DOC_EXAMPLES := $(ALL_DOC_EXAMPLES:%=doc/examples/%$(EXESUF))
27 PROGS += $(DOC_EXAMPLES)
32 documentation: $(DOCS)
34 examples: $(DOC_EXAMPLES)
36 TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
38 GENTEXI = format codec
39 GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
41 $(GENTEXI): TAG = GENTEXI
42 $(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
43 $(M)doc/print_options $* > $@
45 doc/%.html: TAG = HTML
46 doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
48 $(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
51 doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
53 $(M)$(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@
56 doc/%.1: doc/%.pod $(GENTEXI)
57 $(M)pod2man --section=1 --center=" " --release=" " $< > $@
59 $(DOCS) doc/doxy/html: | doc/
60 $(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
61 OBJDIRS += doc/examples
63 DOXY_INPUT = $(addprefix $(SRC_PATH)/, $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c) $(LIB_EXAMPLES:%$(EXESUF)=%.c))
64 DOXY_TEMPLATES = doxy_stylesheet.css footer.html header.html
65 DOXY_TEMPLATES := $(addprefix $(SRC_PATH)/doc/doxy/, $(DOXY_TEMPLATES))
67 doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(DOXY_INPUT) $(DOXY_TEMPLATES)
68 $(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $< $(DOXY_INPUT)
70 install-progs-$(CONFIG_POD2MAN): install-man
71 install-progs-$(CONFIG_TEXI2HTML): install-doc
73 install-doc: $(HTMLPAGES)
74 $(Q)mkdir -p "$(DOCDIR)"
75 $(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
77 install-man: $(MANPAGES)
78 $(Q)mkdir -p "$(MANDIR)/man1"
79 $(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"
81 uninstall: uninstall-doc uninstall-man
87 $(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))
90 $(RM) $(ALL_DOC_EXAMPLES)
91 $(RM) $(CLEANSUFFIXES:%=doc/%) $(CLEANSUFFIXES:%=doc/examples/%)
92 $(RM) doc/*.html doc/*.pod doc/*.1 doc/avoptions_*.texi
93 $(RM) -r doc/doxy/html
95 -include $(wildcard $(DOCS:%=%.d))
97 .PHONY: apidoc documentation