From 552f5f4f89433e39189d5f8808c9e4d7656ea6ee Mon Sep 17 00:00:00 2001 From: Diptorup Deb Date: Tue, 18 May 2021 17:21:20 -0500 Subject: [PATCH] Add a flag to make doxygen HTML generation optional. --- docs/CMakeLists.txt | 10 ++++++++++ docs/Doxyfile.in | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 31593dbda6..bba66d788a 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -14,11 +14,21 @@ option(DPCTL_USE_MULTIVERSION_TEMPLATE OFF ) +# Option to generate HTML from dpxygen +option(DPCTL_ENABLE_DOXYGEN_HTML + "Enable generation of html files for C API using Doxygen" + OFF +) + # This function defines everything needed to generate Doxygen docs function(_setup_doxygen) # We generate doxygen only for the public headers to keep the Doxyrest # generated rst files clean. # FIXME: make it possible to generate doxygen for all files. + set(GENERATE_HTML "NO") + if(DPCTL_ENABLE_DOXYGEN_HTML) + set(GENERATE_HTML "YES") + endif() set(DOXYGEN_INPUT_DIR ../dpctl-capi/include) set(DOXYGEN_OUTPUT_DIR ${DOC_OUTPUT_DIR}/doxygen) set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 4d4a2a6de9..a1055b7256 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -1180,7 +1180,7 @@ IGNORE_PREFIX = # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. -GENERATE_HTML = YES +GENERATE_HTML = @GENERATE_HTML@ # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of