]> git.sesse.net Git - ffmpeg/blobdiff - doc/Makefile
h264: discard slices of redundant pictures right after parsing the slice header
[ffmpeg] / doc / Makefile
index ffb3c5ce4abebb607c36720027c15e1bbf9c1ada..2f6a5fb0c1985b050db1b5f179d32bf141924d19 100644 (file)
@@ -1,29 +1,46 @@
-MANPAGES    = $(PROGS-yes:%=doc/%.1)
-PODPAGES    = $(PROGS-yes:%=doc/%.pod)
-HTMLPAGES   = $(PROGS-yes:%=doc/%.html)                                 \
+ALLMANPAGES = $(AVBASENAMES:%=%.1)
+MANPAGES    = $(AVPROGS-yes:%=doc/%.1)
+PODPAGES    = $(AVPROGS-yes:%=doc/%.pod)
+HTMLPAGES   = $(AVPROGS-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)
+DOCS-$(CONFIG_POD2MAN)                          += $(MANPAGES) $(PODPAGES)
+DOCS-$(CONFIG_TEXI2HTML)                        += $(HTMLPAGES)
+DOCS = $(DOCS-yes)
 
-all-$(CONFIG_DOC): documentation
+DOC_EXAMPLES-$(CONFIG_AVCODEC_EXAMPLE)          += avcodec
+DOC_EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)     += filter_audio
+DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE)         += metadata
+DOC_EXAMPLES-$(CONFIG_OUTPUT_EXAMPLE)           += output
+DOC_EXAMPLES-$(CONFIG_QSVDEC_EXAMPLE)           += qsvdec
+DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)    += transcode_aac
+ALL_DOC_EXAMPLES = avcodec filter_audio metadata output transcode_aac
 
+DOC_EXAMPLES     := $(DOC_EXAMPLES-yes:%=doc/examples/%$(EXESUF))
+ALL_DOC_EXAMPLES := $(ALL_DOC_EXAMPLES:%=doc/examples/%$(EXESUF))
+PROGS            += $(DOC_EXAMPLES)
+
+all: $(DOCS)
+
+apidoc: doc/doxy/html
 documentation: $(DOCS)
 
-TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
+examples: $(DOC_EXAMPLES)
 
-doc/print_options.o: libavformat/options_table.h libavcodec/options_table.h
+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
+$(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
        $(M)doc/print_options $* > $@
 
 doc/%.html: TAG = HTML
@@ -32,7 +49,7 @@ doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init $(GENTEXI)
        $(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
 
 doc/%.pod: TAG = POD
-doc/%.pod: doc/%.texi $(GENTEXI)
+doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl $(GENTEXI)
        $(Q)$(TEXIDEP)
        $(M)$(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@
 
@@ -40,22 +57,42 @@ doc/%.1: TAG = MAN
 doc/%.1: doc/%.pod $(GENTEXI)
        $(M)pod2man --section=1 --center=" " --release=" " $< > $@
 
-$(DOCS): | doc
+$(DOCS) doc/doxy/html: | doc/
+$(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
+OBJDIRS += doc/examples
 
-install-progs-$(CONFIG_DOC): install-man
+DOXY_INPUT      = $(addprefix $(SRC_PATH)/, $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c) $(LIB_EXAMPLES:%$(EXESUF)=%.c))
+DOXY_TEMPLATES  = doxy_stylesheet.css footer.html header.html
+DOXY_TEMPLATES := $(addprefix $(SRC_PATH)/doc/doxy/, $(DOXY_TEMPLATES))
+
+doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(DOXY_INPUT) $(DOXY_TEMPLATES)
+       $(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $< $(DOXY_INPUT)
+
+install-progs-$(CONFIG_POD2MAN): install-man
+install-progs-$(CONFIG_TEXI2HTML): install-doc
+
+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-man
+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) $(ALL_DOC_EXAMPLES)
+       $(RM) $(CLEANSUFFIXES:%=doc/%) $(CLEANSUFFIXES:%=doc/examples/%)
+       $(RM) doc/*.html doc/*.pod doc/*.1 doc/avoptions_*.texi
+       $(RM) -r doc/doxy/html
 
 -include $(wildcard $(DOCS:%=%.d))
 
-.PHONY: documentation
+.PHONY: apidoc documentation