derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
39 lines
1.2 KiB
CMake
39 lines
1.2 KiB
CMake
# Copyright (c) Advanced Micro Devices, Inc. All rights reserved.
|
|
#
|
|
# SPDX-License-Identifier: MIT
|
|
|
|
include_guard(GLOBAL)
|
|
|
|
#-----------------------------------------------------------------------------
|
|
# Option to build the hipFile API documentation
|
|
#-----------------------------------------------------------------------------
|
|
option(AIS_BUILD_DOCS "Build hipFile API docs (requires Doxygen)" OFF)
|
|
|
|
if(AIS_BUILD_DOCS)
|
|
find_package(Doxygen REQUIRED)
|
|
|
|
# Set Doxygen input (pasted into Doxyfile.in)
|
|
set(AIS_DOXYFILE_INPUT "${HIPFILE_ROOT_PATH}/include")
|
|
|
|
# Set the path to the documentation
|
|
set(AIS_DOC_PATH "${CMAKE_CURRENT_BINARY_DIR}/docs")
|
|
|
|
# Set the Doxyfile install location
|
|
set(AIS_DOXYFILE ${AIS_DOC_PATH}/Doxyfile)
|
|
|
|
# Create the Doxyfile from the input file
|
|
configure_file("docs/doxygen/Doxyfile.in" ${AIS_DOXYFILE})
|
|
|
|
# Set the output directory
|
|
set(DOXYGEN_OUT ${AIS_DOC_PATH})
|
|
|
|
# Configure the documentation build
|
|
add_custom_target("doc"
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${AIS_DOXYFILE}
|
|
WORKING_DIRECTORY ${AIS_DOC_PATH}
|
|
COMMENT "Generating hipFile API documentation with Doxygen"
|
|
VERBATIM
|
|
)
|
|
|
|
endif()
|