You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

102 lines
3.5KB

  1. ALLMANPAGES = $(AVBASENAMES:%=%.1)
  2. MANPAGES = $(AVPROGS-yes:%=doc/%.1)
  3. PODPAGES = $(AVPROGS-yes:%=doc/%.pod)
  4. PROGSHTML = $(AVPROGS-yes:%=doc/%.html)
  5. HTMLPAGES = $(PROGSHTML) \
  6. doc/developer.html \
  7. doc/faq.html \
  8. doc/fate.html \
  9. doc/general.html \
  10. doc/git-howto.html \
  11. doc/libavfilter.html \
  12. doc/nut.html \
  13. doc/platform.html \
  14. DOCS-$(CONFIG_POD2MAN) += $(MANPAGES) $(PODPAGES)
  15. DOCS-$(CONFIG_TEXI2HTML) += $(HTMLPAGES)
  16. DOCS = $(DOCS-yes)
  17. DOC_EXAMPLES-$(CONFIG_AVCODEC_EXAMPLE) += avcodec
  18. DOC_EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE) += filter_audio
  19. DOC_EXAMPLES-$(CONFIG_METADATA_EXAMPLE) += metadata
  20. DOC_EXAMPLES-$(CONFIG_OUTPUT_EXAMPLE) += output
  21. DOC_EXAMPLES-$(CONFIG_QSVDEC_EXAMPLE) += qsvdec
  22. DOC_EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE) += transcode_aac
  23. ALL_DOC_EXAMPLES = avcodec filter_audio metadata output transcode_aac
  24. DOC_EXAMPLES := $(DOC_EXAMPLES-yes:%=doc/examples/%$(EXESUF))
  25. ALL_DOC_EXAMPLES := $(ALL_DOC_EXAMPLES:%=doc/examples/%$(EXESUF))
  26. PROGS += $(DOC_EXAMPLES)
  27. all: $(DOCS)
  28. apidoc: doc/doxy/html
  29. documentation: $(DOCS)
  30. examples: $(DOC_EXAMPLES)
  31. TEXIDEP = awk '/^@include/ { printf "$@: $(@D)/%s\n", $$2 }' <$< >$(@:%=%.d)
  32. GENTEXI = format codec
  33. GENTEXI := $(GENTEXI:%=doc/avoptions_%.texi)
  34. $(MANPAGES) $(PODPAGES) $(PROGSHTML): $(GENTEXI)
  35. $(GENTEXI): TAG = GENTEXI
  36. $(GENTEXI): doc/avoptions_%.texi: doc/print_options$(HOSTEXESUF)
  37. $(M)doc/print_options $* > $@
  38. doc/%.html: TAG = HTML
  39. doc/%.html: doc/%.texi $(SRC_PATH)/doc/t2h.init
  40. $(Q)$(TEXIDEP)
  41. $(M)texi2html -I doc -monolithic --init-file $(SRC_PATH)/doc/t2h.init --output $@ $<
  42. doc/%.pod: TAG = POD
  43. doc/%.pod: doc/%.texi $(SRC_PATH)/doc/texi2pod.pl
  44. $(Q)$(TEXIDEP)
  45. $(M)$(SRC_PATH)/doc/texi2pod.pl -Idoc $< $@
  46. doc/%.1: TAG = MAN
  47. doc/%.1: doc/%.pod
  48. $(M)pod2man --section=1 --center=" " --release=" " $< > $@
  49. $(DOCS) doc/doxy/html: | doc/
  50. $(DOC_EXAMPLES:%$(EXESUF)=%.o): | doc/examples
  51. OBJDIRS += doc/examples
  52. DOXY_INPUT = $(addprefix $(SRC_PATH)/, $(INSTHEADERS) $(DOC_EXAMPLES:%$(EXESUF)=%.c) $(LIB_EXAMPLES:%$(EXESUF)=%.c))
  53. DOXY_TEMPLATES = doxy_stylesheet.css footer.html header.html
  54. DOXY_TEMPLATES := $(addprefix $(SRC_PATH)/doc/doxy/, $(DOXY_TEMPLATES))
  55. doc/doxy/html: $(SRC_PATH)/doc/Doxyfile $(DOXY_INPUT) $(DOXY_TEMPLATES)
  56. $(M)$(SRC_PATH)/doc/doxy-wrapper.sh $(SRC_PATH) $< $(DOXY_INPUT)
  57. install-progs-$(CONFIG_POD2MAN): install-man
  58. install-progs-$(CONFIG_TEXI2HTML): install-doc
  59. install-doc: $(HTMLPAGES)
  60. $(Q)mkdir -p "$(DOCDIR)"
  61. $(INSTALL) -m 644 $(HTMLPAGES) "$(DOCDIR)"
  62. install-man: $(MANPAGES)
  63. $(Q)mkdir -p "$(MANDIR)/man1"
  64. $(INSTALL) -m 644 $(MANPAGES) "$(MANDIR)/man1"
  65. uninstall: uninstall-doc uninstall-man
  66. uninstall-doc:
  67. $(RM) -r "$(DOCDIR)"
  68. uninstall-man:
  69. $(RM) $(addprefix "$(MANDIR)/man1/",$(ALLMANPAGES))
  70. clean::
  71. $(RM) $(ALL_DOC_EXAMPLES)
  72. $(RM) $(CLEANSUFFIXES:%=doc/%) $(CLEANSUFFIXES:%=doc/examples/%)
  73. $(RM) doc/*.html doc/*.pod doc/*.1 doc/avoptions_*.texi
  74. $(RM) -r doc/doxy/html
  75. -include $(wildcard $(DOCS:%=%.d))
  76. .PHONY: apidoc documentation