CMakeLists.txt 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. if (DOXYGEN_FOUND)
  2. if (LLVM_ENABLE_DOXYGEN)
  3. set(abs_top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
  4. set(abs_top_builddir ${CMAKE_CURRENT_BINARY_DIR})
  5. if (HAVE_DOT)
  6. set(DOT ${LLVM_PATH_DOT})
  7. endif()
  8. if (LLVM_DOXYGEN_EXTERNAL_SEARCH)
  9. set(enable_searchengine "YES")
  10. set(searchengine_url "${LLVM_DOXYGEN_SEARCHENGINE_URL}")
  11. set(enable_server_based_search "YES")
  12. set(enable_external_search "YES")
  13. set(extra_search_mappings "${LLVM_DOXYGEN_SEARCH_MAPPINGS}")
  14. else()
  15. set(enable_searchengine "NO")
  16. set(searchengine_url "")
  17. set(enable_server_based_search "NO")
  18. set(enable_external_search "NO")
  19. set(extra_search_mappings "")
  20. endif()
  21. # If asked, configure doxygen for the creation of a Qt Compressed Help file.
  22. option(LLVM_ENABLE_DOXYGEN_QT_HELP
  23. "Generate a Qt Compressed Help file." OFF)
  24. if (LLVM_ENABLE_DOXYGEN_QT_HELP)
  25. set(LLVM_DOXYGEN_QCH_FILENAME "org.llvm.qch" CACHE STRING
  26. "Filename of the Qt Compressed help file")
  27. set(LLVM_DOXYGEN_QHP_NAMESPACE "org.llvm" CACHE STRING
  28. "Namespace under which the intermediate Qt Help Project file lives")
  29. set(LLVM_DOXYGEN_QHP_CUST_FILTER_NAME "${PACKAGE_STRING}" CACHE STRING
  30. "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")
  31. set(LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS "${PACKAGE_NAME},${PACKAGE_VERSION}" CACHE STRING
  32. "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")
  33. find_program(LLVM_DOXYGEN_QHELPGENERATOR_PATH qhelpgenerator
  34. DOC "Path to the qhelpgenerator binary")
  35. if (NOT LLVM_DOXYGEN_QHELPGENERATOR_PATH)
  36. message(FATAL_ERROR "Failed to find qhelpgenerator binary")
  37. endif()
  38. set(llvm_doxygen_generate_qhp "YES")
  39. set(llvm_doxygen_qch_filename "${LLVM_DOXYGEN_QCH_FILENAME}")
  40. set(llvm_doxygen_qhp_namespace "${LLVM_DOXYGEN_QHP_NAMESPACE}")
  41. set(llvm_doxygen_qhelpgenerator_path "${LLVM_DOXYGEN_QHELPGENERATOR_PATH}")
  42. set(llvm_doxygen_qhp_cust_filter_name "${LLVM_DOXYGEN_QHP_CUST_FILTER_NAME}")
  43. set(llvm_doxygen_qhp_cust_filter_attrs "${LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS}")
  44. else()
  45. set(llvm_doxygen_generate_qhp "NO")
  46. set(llvm_doxygen_qch_filename "")
  47. set(llvm_doxygen_qhp_namespace "")
  48. set(llvm_doxygen_qhelpgenerator_path "")
  49. set(llvm_doxygen_qhp_cust_filter_name "")
  50. set(llvm_doxygen_qhp_cust_filter_attrs "")
  51. endif()
  52. option(LLVM_DOXYGEN_SVG
  53. "Use svg instead of png files for doxygen graphs." OFF)
  54. if (LLVM_DOXYGEN_SVG)
  55. set(DOT_IMAGE_FORMAT "svg")
  56. else()
  57. set(DOT_IMAGE_FORMAT "png")
  58. endif()
  59. configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in
  60. ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY)
  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(llvm_doxygen_generate_qhp)
  70. set(llvm_doxygen_qch_filename)
  71. set(llvm_doxygen_qhp_namespace)
  72. set(llvm_doxygen_qhelpgenerator_path)
  73. set(llvm_doxygen_qhp_cust_filter_name)
  74. set(llvm_doxygen_qhp_cust_filter_attrs)
  75. set(DOT_IMAGE_FORMAT)
  76. add_custom_target(doxygen-llvm
  77. COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg
  78. WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
  79. COMMENT "Generating llvm doxygen documentation." VERBATIM)
  80. if (LLVM_BUILD_DOCS)
  81. add_dependencies(doxygen doxygen-llvm)
  82. endif()
  83. if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
  84. # ./ suffix is needed to copy the contents of html directory without
  85. # appending html/ into LLVM_INSTALL_DOXYGEN_HTML_DIR.
  86. install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html/.
  87. COMPONENT doxygen-html
  88. DESTINATION "${LLVM_INSTALL_DOXYGEN_HTML_DIR}")
  89. endif()
  90. endif()
  91. endif()
  92. if (LLVM_ENABLE_SPHINX)
  93. include(AddSphinxTarget)
  94. if (SPHINX_FOUND)
  95. if (${SPHINX_OUTPUT_HTML})
  96. add_sphinx_target(html llvm)
  97. endif()
  98. if (${SPHINX_OUTPUT_MAN})
  99. add_sphinx_target(man llvm)
  100. add_sphinx_target(man llvm-dwarfdump)
  101. add_sphinx_target(man dsymutil)
  102. endif()
  103. endif()
  104. endif()
  105. list(FIND LLVM_BINDINGS_LIST ocaml uses_ocaml)
  106. if( NOT uses_ocaml LESS 0 AND LLVM_ENABLE_OCAMLDOC )
  107. set(doc_targets
  108. ocaml_llvm
  109. ocaml_llvm_all_backends
  110. ocaml_llvm_analysis
  111. ocaml_llvm_bitreader
  112. ocaml_llvm_bitwriter
  113. ocaml_llvm_executionengine
  114. ocaml_llvm_irreader
  115. ocaml_llvm_linker
  116. ocaml_llvm_target
  117. ocaml_llvm_ipo
  118. ocaml_llvm_passmgr_builder
  119. ocaml_llvm_scalar_opts
  120. ocaml_llvm_transform_utils
  121. ocaml_llvm_vectorize
  122. )
  123. foreach(llvm_target ${LLVM_TARGETS_TO_BUILD})
  124. list(APPEND doc_targets ocaml_llvm_${llvm_target})
  125. endforeach()
  126. set(odoc_files)
  127. foreach( doc_target ${doc_targets} )
  128. get_target_property(odoc_file ${doc_target} OCAML_ODOC)
  129. list(APPEND odoc_files -load ${odoc_file})
  130. endforeach()
  131. add_custom_target(ocaml_doc
  132. COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html
  133. COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html
  134. COMMAND ${OCAMLFIND} ocamldoc -d ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html
  135. -sort -colorize-code -html ${odoc_files}
  136. COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/_ocamldoc/style.css
  137. ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html)
  138. add_dependencies(ocaml_doc ${doc_targets})
  139. if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
  140. # ./ suffix is needed to copy the contents of html directory without
  141. # appending html/ into LLVM_INSTALL_OCAMLDOC_HTML_DIR.
  142. install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html/.
  143. COMPONENT ocamldoc-html
  144. DESTINATION "${LLVM_INSTALL_OCAMLDOC_HTML_DIR}")
  145. endif()
  146. endif()