X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=mk%2Frte.sdkdoc.mk;h=bce57c5dabaf972bd49b6f2817d963f8fd75bf71;hb=5751ff40fed0f7dc359e983d80c768126328561f;hp=21d9bdf2aae4267546d73c825faf643cc2b3fc89;hpb=576de42b83e505fe87eedf0fca0e07f6b5d3bad9;p=dpdk.git diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk index 21d9bdf2aa..bce57c5dab 100644 --- a/mk/rte.sdkdoc.mk +++ b/mk/rte.sdkdoc.mk @@ -54,6 +54,8 @@ RTE_PDF_DPI ?= 300 RTE_GUIDES := $(filter %/, $(wildcard $(RTE_SDK)/doc/guides/*/)) +API_EXAMPLES := $(RTE_OUTPUT)/doc/html/examples.dox + .PHONY: help help: @cat $(RTE_SDK)/doc/build-sdk-quick.txt @@ -66,12 +68,13 @@ all: api-html guides-html guides-pdf clean: api-html-clean guides-html-clean guides-pdf-clean guides-man-clean .PHONY: api-html -api-html: api-html-clean +api-html: $(API_EXAMPLES) @echo 'doxygen for API...' $(Q)mkdir -p $(RTE_OUTPUT)/doc/html $(Q)(cat $(RTE_SDK)/doc/api/doxy-api.conf && \ printf 'PROJECT_NUMBER = ' && \ - $(MAKE) -rR showversion && \ + $(MAKE) -rRs showversion && \ + echo INPUT += $(API_EXAMPLES) && \ echo OUTPUT_DIRECTORY = $(RTE_OUTPUT)/doc && \ echo HTML_OUTPUT = html/api && \ echo GENERATE_HTML = YES && \ @@ -82,9 +85,17 @@ api-html: api-html-clean .PHONY: api-html-clean api-html-clean: + $(Q)rm -f $(API_EXAMPLES) $(Q)rm -f $(RTE_OUTPUT)/doc/html/api/* $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true +$(API_EXAMPLES): api-html-clean + $(Q)mkdir -p $(@D) + @printf '/**\n' > $(API_EXAMPLES) + @printf '@page examples DPDK Example Programs\n\n' >> $(API_EXAMPLES) + @find examples -type f -name '*.c' -printf '@example %p\n' | LC_ALL=C sort >> $(API_EXAMPLES) + @printf '*/\n' >> $(API_EXAMPLES) + guides-pdf-clean: guides-pdf-img-clean guides-pdf-img-clean: $(Q)rm -f $(RTE_SDK)/doc/guides/*/img/*.pdf @@ -106,7 +117,13 @@ guides-pdf-%: $(Q)mv $(RTE_OUTPUT)/doc/pdf/guides/$*/doc.pdf \ $(RTE_OUTPUT)/doc/pdf/guides/$*.pdf -guides-%: +guides-html-prepare: + $(Q)install -D -m0644 $(RTE_SDK)/doc/guides/custom.css \ + $(RTE_OUTPUT)/doc/html/guides/_static/css/custom.css + +guides-%-prepare: ; + +guides-%: guides-%-prepare @echo 'sphinx processing $@...' $(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \ -c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides \