xref: /llvm-project/mlir/docs/CMakeLists.txt (revision 064391df493927729fa79fb5b966efba2eb1e170)
1
2if (DOXYGEN_FOUND)
3if (LLVM_ENABLE_DOXYGEN)
4  set(abs_top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
5  set(abs_top_builddir ${CMAKE_CURRENT_BINARY_DIR})
6
7  if (HAVE_DOT)
8    set(DOT ${LLVM_PATH_DOT})
9  endif()
10
11  if (LLVM_DOXYGEN_EXTERNAL_SEARCH)
12    set(enable_searchengine "YES")
13    set(searchengine_url "${LLVM_DOXYGEN_SEARCHENGINE_URL}")
14    set(enable_server_based_search "YES")
15    set(enable_external_search "YES")
16    set(extra_search_mappings "${LLVM_DOXYGEN_SEARCH_MAPPINGS}")
17  else()
18    set(enable_searchengine "NO")
19    set(searchengine_url "")
20    set(enable_server_based_search "NO")
21    set(enable_external_search "NO")
22    set(extra_search_mappings "")
23  endif()
24
25  # If asked, configure doxygen for the creation of a Qt Compressed Help file.
26  if (LLVM_ENABLE_DOXYGEN_QT_HELP)
27    set(MLIR_DOXYGEN_QCH_FILENAME "org.llvm.mlir.qch" CACHE STRING
28      "Filename of the Qt Compressed help file")
29    set(MLIR_DOXYGEN_QHP_NAMESPACE "org.llvm.mlir" CACHE STRING
30      "Namespace under which the intermediate Qt Help Project file lives")
31    set(MLIR_DOXYGEN_QHP_CUST_FILTER_NAME "MLIR ${MLIR_VERSION}" CACHE STRING
32      "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")
33    set(MLIR_DOXYGEN_QHP_CUST_FILTER_ATTRS "MLIR,${MLIR_VERSION}" CACHE STRING
34      "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")
35    set(mlir_doxygen_generate_qhp "YES")
36    set(mlir_doxygen_qch_filename "${MLIR_DOXYGEN_QCH_FILENAME}")
37    set(mlir_doxygen_qhp_namespace "${MLIR_DOXYGEN_QHP_NAMESPACE}")
38    set(mlir_doxygen_qhelpgenerator_path "${LLVM_DOXYGEN_QHELPGENERATOR_PATH}")
39    set(mlir_doxygen_qhp_cust_filter_name "${MLIR_DOXYGEN_QHP_CUST_FILTER_NAME}")
40    set(mlir_doxygen_qhp_cust_filter_attrs "${MLIR_DOXYGEN_QHP_CUST_FILTER_ATTRS}")
41  else()
42    set(mlir_doxygen_generate_qhp "NO")
43    set(mlir_doxygen_qch_filename "")
44    set(mlir_doxygen_qhp_namespace "")
45    set(mlir_doxygen_qhelpgenerator_path "")
46    set(mlir_doxygen_qhp_cust_filter_name "")
47    set(mlir_doxygen_qhp_cust_filter_attrs "")
48  endif()
49
50  option(LLVM_DOXYGEN_SVG
51    "Use svg instead of png files for doxygen graphs." OFF)
52  if (LLVM_DOXYGEN_SVG)
53    set(DOT_IMAGE_FORMAT "svg")
54  else()
55    set(DOT_IMAGE_FORMAT "png")
56  endif()
57
58  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in
59    ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY)
60
61  set(abs_top_srcdir)
62  set(abs_top_builddir)
63  set(DOT)
64  set(enable_searchengine)
65  set(searchengine_url)
66  set(enable_server_based_search)
67  set(enable_external_search)
68  set(extra_search_mappings)
69  set(mlir_doxygen_generate_qhp)
70  set(mlir_doxygen_qch_filename)
71  set(mlir_doxygen_qhp_namespace)
72  set(mlir_doxygen_qhelpgenerator_path)
73  set(mlir_doxygen_qhp_cust_filter_name)
74  set(mlir_doxygen_qhp_cust_filter_attrs)
75  set(DOT_IMAGE_FORMAT)
76
77  add_custom_target(doxygen-mlir
78    COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg
79    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
80    COMMENT "Generating mlir doxygen documentation." VERBATIM)
81  set_target_properties(doxygen-mlir PROPERTIES FOLDER "MLIR/Docs")
82
83  if (LLVM_BUILD_DOCS)
84    add_dependencies(doxygen doxygen-mlir)
85  endif()
86
87  if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
88    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html
89      DESTINATION docs/html)
90  endif()
91endif()
92endif()
93
94