Merge branch 'hotfix/v01.05.01'
[tidl/tidl-api.git] / docs / Makefile
index a8ae35e956e853ed9d4b23771ac292408e1e80a4..667f50add46b13fffd9561ba609c22f60b997513 100644 (file)
@@ -1,5 +1,32 @@
-# Makefile for Sphinx documentation
+# Copyright (c) 2018 Texas Instruments Incorporated - http://www.ti.com/
+# 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
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# * Neither the name of Texas Instruments Incorporated 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 A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+# THE POSSIBILITY OF SUCH DAMAGE.
+
+# Makefile for Sphinx documentation
+# Uses breathe to integrate doxygen API documentation into sphinx
+# https://breathe.readthedocs.io/en/latest/
 
 default: html
 
@@ -7,7 +34,6 @@ default: html
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-#BUILDDIR      = /var/www/mctools/opencl
 BUILDDIR      = build
 
 # User-friendly check for sphinx-build
@@ -54,7 +80,7 @@ help:
 clean:
        rm -rf $(BUILDDIR)/*
 
-html: 
+html: api-xml 
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
        @echo
        @echo "Build finished. The HTML pages are in $(BUILDDIR)."
@@ -196,3 +222,6 @@ pseudoxml:
 
 artifacts:
        $(MAKE) -c artifacts
+
+api-xml:
+       (cd ../tidl_api/doxygen; doxygen)