X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=mk%2Frte.sdkdoc.mk;h=dabc0d6e7423d46b9ce2e9df71224f8f54fa7717;hb=abcc810513c78d40297c30b9ef342ac8ea5d5b8c;hp=175b2643fa1f4ad8a68647576b1499cbdc620fa4;hpb=d71de631d9030153323fab02fe3dfb53613a36eb;p=dpdk.git diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk index 175b2643fa..dabc0d6e74 100644 --- a/mk/rte.sdkdoc.mk +++ b/mk/rte.sdkdoc.mk @@ -1,13 +1,13 @@ # BSD LICENSE -# +# # Copyright(c) 2010-2014 Intel Corporation. All rights reserved. # Copyright(c) 2013 6WIND S.A. # All rights reserved. -# +# # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions # are met: -# +# # * Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # * Redistributions in binary form must reproduce the above copyright @@ -17,7 +17,7 @@ # * Neither the name of Intel Corporation nor the names of its # contributors may be used to endorse or promote products derived # from this software without specific prior written permission. -# +# # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR @@ -36,17 +36,30 @@ $(error "Cannot use T= with doc target") endif endif +RTE_SPHINX_BUILD = sphinx-build +ifndef V +RTE_SPHINX_VERBOSE := -q +endif +ifeq '$V' '0' +RTE_SPHINX_VERBOSE := -q +endif + +.PHONY: help +help: + @cat $(RTE_SDK)/doc/build-sdk-quick.txt + @$(MAKE) -rR showconfigs | sed 's,^,\t\t\t\t,' + .PHONY: all -all: htmlapi +all: api-html guides-html .PHONY: clean -clean: htmlapi-clean +clean: api-html-clean guides-html-clean -.PHONY: htmlapi -htmlapi: htmlapi-clean +.PHONY: api-html +api-html: api-html-clean @echo 'doxygen for API...' $(Q)mkdir -p $(RTE_OUTPUT)/doc/html - $(Q)(cat $(RTE_SDK)/doc/doxy-api.conf && \ + $(Q)(cat $(RTE_SDK)/doc/api/doxy-api.conf && \ printf 'PROJECT_NUMBER = ' && \ $(MAKE) -rR showversion && \ echo OUTPUT_DIRECTORY = $(RTE_OUTPUT)/doc && \ @@ -55,9 +68,18 @@ htmlapi: htmlapi-clean echo GENERATE_LATEX = NO && \ echo GENERATE_MAN = NO )| \ doxygen - - $(Q)$(RTE_SDK)/doc/doxy-html-custom.sh $(RTE_OUTPUT)/doc/html/api/doxygen.css + $(Q)$(RTE_SDK)/doc/api/doxy-html-custom.sh $(RTE_OUTPUT)/doc/html/api/doxygen.css -.PHONY: htmlapi-clean -htmlapi-clean: - $(Q)rm -f $O/doc/html/api/* +.PHONY: api-html-clean +api-html-clean: + $(Q)rm -f $(RTE_OUTPUT)/doc/html/api/* $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true + +guides-%-clean: + $(Q)rm -rf $(RTE_OUTPUT)/doc/$*/guides + $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/$* 2>&- || true + +guides-%: + @echo 'sphinx for guides...' + $(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \ + -c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides $(RTE_OUTPUT)/doc/$*/guides