163 lines · plain
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 option(LLVM_ENABLE_DOXYGEN_QT_HELP27 "Generate a Qt Compressed Help file." OFF)28 if (LLVM_ENABLE_DOXYGEN_QT_HELP)29 set(LLVM_DOXYGEN_QCH_FILENAME "org.llvm.qch" CACHE STRING30 "Filename of the Qt Compressed help file")31 set(LLVM_DOXYGEN_QHP_NAMESPACE "org.llvm" CACHE STRING32 "Namespace under which the intermediate Qt Help Project file lives")33 set(LLVM_DOXYGEN_QHP_CUST_FILTER_NAME "${PACKAGE_STRING}" CACHE STRING34 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")35 set(LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS "${PACKAGE_NAME},${PACKAGE_VERSION}" CACHE STRING36 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")37 find_program(LLVM_DOXYGEN_QHELPGENERATOR_PATH qhelpgenerator38 DOC "Path to the qhelpgenerator binary")39 if (NOT LLVM_DOXYGEN_QHELPGENERATOR_PATH)40 message(FATAL_ERROR "Failed to find qhelpgenerator binary")41 endif()42 43 set(llvm_doxygen_generate_qhp "YES")44 set(llvm_doxygen_qch_filename "${LLVM_DOXYGEN_QCH_FILENAME}")45 set(llvm_doxygen_qhp_namespace "${LLVM_DOXYGEN_QHP_NAMESPACE}")46 set(llvm_doxygen_qhelpgenerator_path "${LLVM_DOXYGEN_QHELPGENERATOR_PATH}")47 set(llvm_doxygen_qhp_cust_filter_name "${LLVM_DOXYGEN_QHP_CUST_FILTER_NAME}")48 set(llvm_doxygen_qhp_cust_filter_attrs "${LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS}")49 50 else()51 set(llvm_doxygen_generate_qhp "NO")52 set(llvm_doxygen_qch_filename "")53 set(llvm_doxygen_qhp_namespace "")54 set(llvm_doxygen_qhelpgenerator_path "")55 set(llvm_doxygen_qhp_cust_filter_name "")56 set(llvm_doxygen_qhp_cust_filter_attrs "")57 endif()58 59 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in60 ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY)61 62 set(abs_top_srcdir)63 set(abs_top_builddir)64 set(DOT)65 set(enable_searchengine)66 set(searchengine_url)67 set(enable_server_based_search)68 set(enable_external_search)69 set(extra_search_mappings)70 set(llvm_doxygen_generate_qhp)71 set(llvm_doxygen_qch_filename)72 set(llvm_doxygen_qhp_namespace)73 set(llvm_doxygen_qhelpgenerator_path)74 set(llvm_doxygen_qhp_cust_filter_name)75 set(llvm_doxygen_qhp_cust_filter_attrs)76 77 add_custom_target(doxygen-llvm78 COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg79 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}80 COMMENT "Generating llvm doxygen documentation." VERBATIM)81 set_target_properties(doxygen-llvm PROPERTIES FOLDER "LLVM/Docs")82 83 if (LLVM_BUILD_DOCS)84 add_dependencies(doxygen doxygen-llvm)85 endif()86 87 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)88 # ./ suffix is needed to copy the contents of html directory without89 # appending html/ into LLVM_INSTALL_DOXYGEN_HTML_DIR.90 install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html/.91 COMPONENT doxygen-html92 DESTINATION "${LLVM_INSTALL_DOXYGEN_HTML_DIR}")93 endif()94endif()95endif()96 97if (LLVM_ENABLE_SPHINX)98 include(AddSphinxTarget)99 if (SPHINX_FOUND)100 if (${SPHINX_OUTPUT_HTML})101 add_sphinx_target(html llvm)102 endif()103 104 105 if (${SPHINX_OUTPUT_MAN})106 add_sphinx_target(man llvm)107 add_sphinx_target(man llvm-dwarfdump)108 add_sphinx_target(man dsymutil)109 endif()110 111 endif()112endif()113 114list(FIND LLVM_BINDINGS_LIST ocaml uses_ocaml)115if( NOT uses_ocaml LESS 0 AND LLVM_ENABLE_OCAMLDOC )116 set(doc_targets117 ocaml_llvm118 ocaml_llvm_all_backends119 ocaml_llvm_analysis120 ocaml_llvm_bitreader121 ocaml_llvm_bitwriter122 ocaml_llvm_executionengine123 ocaml_llvm_irreader124 ocaml_llvm_linker125 ocaml_llvm_target126 ocaml_llvm_transform_utils127 )128 129 foreach(llvm_target ${LLVM_TARGETS_TO_BUILD})130 list(APPEND doc_targets ocaml_llvm_${llvm_target})131 endforeach()132 133 set(odoc_files)134 foreach( doc_target ${doc_targets} )135 get_target_property(odoc_file ${doc_target} OCAML_ODOC)136 list(APPEND odoc_files -load ${odoc_file})137 endforeach()138 139 set(OCAML_DOC_ADD_TO_ALL "")140 if(LLVM_BUILD_DOCS)141 set(OCAML_DOC_ADD_TO_ALL ALL)142 endif()143 144 add_custom_target(ocaml_doc ${OCAML_DOC_ADD_TO_ALL}145 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html146 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html147 COMMAND ${OCAMLFIND} ocamldoc -d ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html148 -sort -colorize-code -html ${odoc_files}149 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/_ocamldoc/style.css150 ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html)151 152 add_dependencies(ocaml_doc ${doc_targets})153 154 155 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY AND LLVM_BUILD_DOCS)156 # ./ suffix is needed to copy the contents of html directory without157 # appending html/ into LLVM_INSTALL_OCAMLDOC_HTML_DIR.158 install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html/.159 COMPONENT ocamldoc-html160 DESTINATION "${LLVM_INSTALL_OCAMLDOC_HTML_DIR}")161 endif()162endif()163