frozenleaves/oneDNN
1
0
Fork 0
mirror of https://github.com/uxlfoundation/oneDNN.git synced 2025-10-20 18:43:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

cmake: doc: add an option to disable documentation

Browse Source
This commit is contained in:
Safonov, Igor
2024-03-12 16:31:22 -07:00
committed by Igor Safonov
parent 903831bf56
commit 9772599d16
4 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
cmake/Doxygen.cmake
View File

@ -1,5 +1,5 @@
#===============================================================================
# Copyright 2016-2023 Intel Corporation
# Copyright 2016-2024 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@ -22,10 +22,6 @@ if(Doxygen_cmake_included)
endif()
set(Doxygen_cmake_included true)
if(NOT DNNL_IS_MAIN_PROJECT)
return()
endif()
find_package(Doxygen)
if(DOXYGEN_FOUND)
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/reference)

11
cmake/doc.cmake
View File

@ -1,5 +1,5 @@
#===============================================================================
# Copyright 2021 Intel Corporation
# Copyright 2021-2024 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@ -14,6 +14,15 @@
# limitations under the License.
#===============================================================================
if (DOC_cmake_included)
return()
endif()
set(DOC_cmake_included true)
if (NOT DNNL_BUILD_DOC)
return()
endif()
include("cmake/Doxygen.cmake")
include("cmake/Doxyrest.cmake")
include("cmake/Sphinx.cmake")

1
cmake/options.cmake
View File

@ -60,6 +60,7 @@ option(ONEDNN_ENABLE_GRAPH_DUMP "enables control of dumping graph artifacts via
set(DNNL_LIBRARY_TYPE "SHARED" CACHE STRING
"specifies whether oneDNN library should be SHARED or STATIC")
option(DNNL_BUILD_DOC "builds documentation" ON)
option(DNNL_BUILD_EXAMPLES "builds examples" ON)
option(DNNL_BUILD_TESTS "builds tests" ON)
option(DNNL_BUILD_FOR_CI

1
doc/build/build_options.md vendored
View File

@ -8,6 +8,7 @@ oneDNN supports the following build-time options.
| ONEDNN_LIBRARY_TYPE | **SHARED**, STATIC | Defines the resulting library type |
| ONEDNN_CPU_RUNTIME | NONE, **OMP**, TBB, SEQ, THREADPOOL, SYCL | Defines the threading runtime for CPU engines |
| ONEDNN_GPU_RUNTIME | **NONE**, OCL, SYCL | Defines the offload runtime for GPU engines |
| ONEDNN_BUILD_DOC | **ON**, OFF | Controls building the documentation |
| ONEDNN_BUILD_EXAMPLES | **ON**, OFF | Controls building the examples |
| ONEDNN_BUILD_TESTS | **ON**, OFF | Controls building the tests |
| ONEDNN_BUILD_GRAPH | **ON**, OFF | Controls building graph component |