mk/rte.sdkdoc.mk

   1 #   BSD LICENSE
   2 #
   3 #   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   4 #   Copyright(c) 2013 6WIND S.A.
   5 #   All rights reserved.
   6 #
   7 #   Redistribution and use in source and binary forms, with or without
   8 #   modification, are permitted provided that the following conditions
   9 #   are met:
  10 #
  11 #     * Redistributions of source code must retain the above copyright
  12 #       notice, this list of conditions and the following disclaimer.
  13 #     * Redistributions in binary form must reproduce the above copyright
  14 #       notice, this list of conditions and the following disclaimer in
  15 #       the documentation and/or other materials provided with the
  16 #       distribution.
  17 #     * Neither the name of Intel Corporation nor the names of its
  18 #       contributors may be used to endorse or promote products derived
  19 #       from this software without specific prior written permission.
  20 #
  21 #   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 #   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 #   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 #   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 #   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 #   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 #   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 #   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 #   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32
  33 ifdef T
  34 ifeq ("$(origin T)", "command line")
  35 $(error "Cannot use T= with doc target")
  36 endif
  37 endif
  38
  39 RTE_SPHINX_BUILD = sphinx-build
  40 ifndef V
  41 RTE_SPHINX_VERBOSE := -q
  42 endif
  43 ifeq '$V' '0'
  44 RTE_SPHINX_VERBOSE := -q
  45 endif
  46
  47 .PHONY: help
  48 help:
  49         @cat $(RTE_SDK)/doc/build-sdk-quick.txt
  50         @$(MAKE) -rR showconfigs | sed 's,^,\t\t\t\t,'
  51
  52 .PHONY: all
  53 all: api-html guides-html
  54
  55 .PHONY: clean
  56 clean: api-html-clean guides-html-clean
  57
  58 .PHONY: api-html
  59 api-html: api-html-clean
  60         @echo 'doxygen for API...'
  61         $(Q)mkdir -p $(RTE_OUTPUT)/doc/html
  62         $(Q)(cat $(RTE_SDK)/doc/api/doxy-api.conf     && \
  63             printf 'PROJECT_NUMBER = '                && \
  64                               $(MAKE) -rR showversion && \
  65             echo OUTPUT_DIRECTORY = $(RTE_OUTPUT)/doc && \
  66             echo HTML_OUTPUT      = html/api          && \
  67             echo GENERATE_HTML    = YES               && \
  68             echo GENERATE_LATEX   = NO                && \
  69             echo GENERATE_MAN     = NO                )| \
  70             doxygen -
  71         $(Q)$(RTE_SDK)/doc/api/doxy-html-custom.sh $(RTE_OUTPUT)/doc/html/api/doxygen.css
  72
  73 .PHONY: api-html-clean
  74 api-html-clean:
  75         $(Q)rm -f $(RTE_OUTPUT)/doc/html/api/*
  76         $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/html/api 2>&- || true
  77
  78 guides-%-clean:
  79         $(Q)rm -rf $(RTE_OUTPUT)/doc/$*/guides
  80         $(Q)rmdir -p --ignore-fail-on-non-empty $(RTE_OUTPUT)/doc/$* 2>&- || true
  81
  82 guides-%:
  83         @echo 'sphinx for guides...'
  84         $(Q)$(RTE_SPHINX_BUILD) -b $* $(RTE_SPHINX_VERBOSE) \
  85                 -c $(RTE_SDK)/doc/guides $(RTE_SDK)/doc/guides $(RTE_OUTPUT)/doc/$*/guides