Doxyrest.cmake

#===============================================================================
# Copyright 2021-2022 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#===============================================================================

# Locates Doxyrest and configures documentation translation from .xml to .rst
#===============================================================================

if(Doxyrest_cmake_included)
    return()
endif()
set(Doxyrest_cmake_included true)

find_package(Doxyrest)
if (DOXYREST_FOUND)
    set(DOXYREST_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/reference)
    set(DOXYREST_STAMP_FILE ${CMAKE_CURRENT_BINARY_DIR}/doxyrest.stamp)
    set(DOXYREST_FRAME_DIR ${CMAKE_CURRENT_BINARY_DIR}/frame)
    file(GLOB_RECURSE DOXYREST_CONFIGS
        ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxyrest/doxyrest-config.lua
        )
    file(COPY ${DOXYREST_CONFIGS}
        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}
        )
    file(MAKE_DIRECTORY ${DOXYREST_FRAME_DIR})
    add_custom_command(
        OUTPUT ${DOXYREST_STAMP_FILE}
        DEPENDS ${DOXYGEN_STAMP_FILE} ${DOXYREST_CONFIGS}
            COMMAND ${CMAKE_COMMAND} -E copy_directory
            ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxyrest/frame
            ${DOXYREST_FRAME_DIR}
        COMMAND ${DOXYREST_EXECUTABLE}
            --frame-dir=${DOXYREST_FRAME_DIR}/common
            --frame-dir=${DOXYREST_FRAME_DIR}/cfamily
            --config=${CMAKE_CURRENT_BINARY_DIR}/doxyrest-config.lua
        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/doc/rst ${DOXYREST_OUTPUT_DIR}/rst
        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/doc/graph/rst ${DOXYREST_OUTPUT_DIR}/rst
        COMMAND ${CMAKE_COMMAND} -E touch ${DOXYREST_STAMP_FILE}
        WORKING_DIRECTORY ${DOXYREST_OUTPUT_DIR}
        COMMENT "Translating documentation from .xml to .rst with Doxyrest" VERBATIM)
    add_custom_target(doc_doxyrest DEPENDS ${DOXYREST_STAMP_FILE} doc_doxygen)
endif(DOXYREST_FOUND)