aboutsummaryrefslogtreecommitdiff
path: root/doxygen
diff options
context:
space:
mode:
authorMinos Galanakis <minos.galanakis@arm.com>2020-06-03 15:38:03 +0100
committerTamas Ban <tamas.ban@arm.com>2020-09-24 12:49:54 +0000
commitd19a19f161148b97f3ec8ccec7baebd79599f8c4 (patch)
treeb7d1f354d0a33d533b74f7bcdc3b9865b360504e /doxygen
parent7b95029a5864ce834e9535ce96da92be3f418a54 (diff)
downloadtrusted-firmware-m-d19a19f161148b97f3ec8ccec7baebd79599f8c4.tar.gz
Docs: Decouple from CMAKE and enable sphynx-build.
This patch is reducing the dependency of the documentation to the TrustedFirmware-M build environment. Currently CMake will copy over files from platforms, render the configuration files, sort design documents and invoke the corresponding tools to build the documentation. This patch introduces an environment communicating interface file, which CMAKE will need to populate, before calling the build command. The file copy operation has been moved over to the sphynx-build logic, and the design document’s classification is no longer required by the new user interface. The new implemenatation allows: * Documentation can be built in an identical way through the build system, retaining compatibility with existing tools, such as the CI. * It is now possible to build documentation, by just invoking sphynx-build from the build-docs directory. * Third party tools/services like readthedocs.org can now render the TF-M documentation. * Reduced CMake code size. * Documentation generating logic invokes ‘git describe’ in order to determine a version. The order of precedence is set as: Git Describe Version-> CMake hardcoded version -> Template version. * CMake logic can still toggle parts of the new logic on and off if required. * The full set of TF-M build dependencies are not longer required in order to build documentation. Just the documentation dependencies would suffice. Change-Id: I12e7bbffe9d1adb756329c46da13905e95096381 Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
Diffstat (limited to 'doxygen')
-rw-r--r--doxygen/Doxyfile.in4
1 files changed, 2 insertions, 2 deletions
diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in
index 9a1e47504..ccfa60cc6 100644
--- a/doxygen/Doxyfile.in
+++ b/doxygen/Doxyfile.in
@@ -1,5 +1,5 @@
#-------------------------------------------------------------------------------
-# Copyright (c) 2018-2019, Arm Limited. All rights reserved.
+# Copyright (c) 2018-2020, Arm Limited. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
@@ -58,7 +58,7 @@ PROJECT_BRIEF = Trusted Firmware-M
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
-PROJECT_LOGO = ./doxygen/TrustedFirmware-Logo_icon.png
+PROJECT_LOGO = @TFM_ROOT_DIR@/doxygen/TrustedFirmware-Logo_icon.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is