170 lines · plain
1 2if (DOXYGEN_FOUND)3if (LLVM_ENABLE_DOXYGEN)4 set(abs_srcdir ${CMAKE_CURRENT_SOURCE_DIR})5 set(abs_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(CLANG_DOXYGEN_QCH_FILENAME "org.llvm.clang.qch" CACHE STRING28 "Filename of the Qt Compressed help file")29 set(CLANG_DOXYGEN_QHP_NAMESPACE "org.llvm.clang" CACHE STRING30 "Namespace under which the intermediate Qt Help Project file lives")31 set(CLANG_DOXYGEN_QHP_CUST_FILTER_NAME "Clang ${CLANG_VERSION}" CACHE STRING32 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")33 set(CLANG_DOXYGEN_QHP_CUST_FILTER_ATTRS "Clang,${CLANG_VERSION}" CACHE STRING34 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")35 set(clang_doxygen_generate_qhp "YES")36 set(clang_doxygen_qch_filename "${CLANG_DOXYGEN_QCH_FILENAME}")37 set(clang_doxygen_qhp_namespace "${CLANG_DOXYGEN_QHP_NAMESPACE}")38 set(clang_doxygen_qhelpgenerator_path "${LLVM_DOXYGEN_QHELPGENERATOR_PATH}")39 set(clang_doxygen_qhp_cust_filter_name "${CLANG_DOXYGEN_QHP_CUST_FILTER_NAME}")40 set(clang_doxygen_qhp_cust_filter_attrs "${CLANG_DOXYGEN_QHP_CUST_FILTER_ATTRS}")41 else()42 set(clang_doxygen_generate_qhp "NO")43 set(clang_doxygen_qch_filename "")44 set(clang_doxygen_qhp_namespace "")45 set(clang_doxygen_qhelpgenerator_path "")46 set(clang_doxygen_qhp_cust_filter_name "")47 set(clang_doxygen_qhp_cust_filter_attrs "")48 endif()49 50 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in51 ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY)52 53 set(abs_top_srcdir)54 set(abs_top_builddir)55 set(DOT)56 set(enable_searchengine)57 set(searchengine_url)58 set(enable_server_based_search)59 set(enable_external_search)60 set(extra_search_mappings)61 set(clang_doxygen_generate_qhp)62 set(clang_doxygen_qch_filename)63 set(clang_doxygen_qhp_namespace)64 set(clang_doxygen_qhelpgenerator_path)65 set(clang_doxygen_qhp_cust_filter_name)66 set(clang_doxygen_qhp_cust_filter_attrs)67 68 add_custom_target(doxygen-clang69 COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg70 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}71 COMMENT "Generating clang doxygen documentation." VERBATIM)72 set_target_properties(doxygen-clang PROPERTIES FOLDER "Clang/Docs")73 74 if (LLVM_BUILD_DOCS)75 add_dependencies(doxygen doxygen-clang)76 endif()77 78 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)79 install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html80 DESTINATION docs/html)81 endif()82endif()83endif()84 85function (gen_rst_file_from_td output_file td_option source docs_targets)86 if (NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${source}")87 message(FATAL_ERROR "Cannot find source file: ${source} in ${CMAKE_CURRENT_SOURCE_DIR}")88 endif()89 get_filename_component(TABLEGEN_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${source}" DIRECTORY)90 list(APPEND LLVM_TABLEGEN_FLAGS "-I${TABLEGEN_INCLUDE_DIR}")91 clang_tablegen(${output_file} ${td_option} SOURCE ${source} TARGET "gen-${output_file}")92 foreach(target ${docs_targets})93 add_dependencies(${target} gen-${output_file})94 endforeach()95endfunction()96 97if (LLVM_ENABLE_SPHINX)98 include(AddSphinxTarget)99 if (SPHINX_FOUND AND (${SPHINX_OUTPUT_HTML} OR ${SPHINX_OUTPUT_MAN}))100 # Copy rst files to build directory before generating the html101 # documentation. Some of the rst files are generated, so they102 # only exist in the build directory. Sphinx needs all files in103 # the same directory in order to generate the html, so we need to104 # copy all the non-gnerated rst files from the source to the build105 # directory before we run sphinx.106 add_custom_target(copy-clang-rst-docs107 COMMAND "${CMAKE_COMMAND}" -E copy_directory108 "${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_CURRENT_BINARY_DIR}"109 110 COMMAND "${CMAKE_COMMAND}" -E copy_if_different111 "${CMAKE_CURRENT_SOURCE_DIR}/../Maintainers.rst"112 "${CMAKE_CURRENT_BINARY_DIR}"113 )114 115 set(docs_targets "")116 117 if (${SPHINX_OUTPUT_HTML})118 add_sphinx_target(html clang SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}")119 120 add_custom_command(TARGET docs-clang-html POST_BUILD121 COMMAND "${CMAKE_COMMAND}" -E copy122 "${CMAKE_CURRENT_SOURCE_DIR}/LibASTMatchersReference.html"123 "${CMAKE_CURRENT_BINARY_DIR}/html/LibASTMatchersReference.html")124 125 list(APPEND docs_targets "docs-clang-html")126 endif()127 if (${SPHINX_OUTPUT_MAN})128 add_sphinx_target(man clang SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}")129 list(APPEND docs_targets "docs-clang-man")130 endif()131 132 # Generated files133 gen_rst_file_from_td(AttributeReference.rst -gen-attr-docs ../include/clang/Basic/Attr.td "${docs_targets}")134 gen_rst_file_from_td(DiagnosticsReference.rst -gen-diag-docs ../include/clang/Basic/Diagnostic.td "${docs_targets}")135 gen_rst_file_from_td(ClangCommandLineReference.rst -gen-opt-docs ../include/clang/Options/ClangOptionDocs.td "${docs_targets}")136 137 # Another generated file from a different source138 set(docs_tools_dir ${CMAKE_CURRENT_SOURCE_DIR}/tools)139 set(aopts_rst_rel_path analyzer/user-docs/Options.rst)140 set(aopts_rst "${CMAKE_CURRENT_BINARY_DIR}/${aopts_rst_rel_path}")141 set(analyzeroptions_def "${CMAKE_CURRENT_SOURCE_DIR}/../include/clang/StaticAnalyzer/Core/AnalyzerOptions.def")142 set(aopts_rst_in "${CMAKE_CURRENT_SOURCE_DIR}/${aopts_rst_rel_path}.in")143 add_custom_command(144 OUTPUT ${aopts_rst}145 COMMAND ${Python3_EXECUTABLE} generate_analyzer_options_docs.py146 --options-def "${analyzeroptions_def}"147 --template "${aopts_rst_in}"148 --out "${aopts_rst}"149 WORKING_DIRECTORY ${docs_tools_dir}150 VERBATIM151 COMMENT "Generating ${aopts_rst}"152 DEPENDS ${docs_tools_dir}/${generate_aopts_docs}153 ${aopts_rst_in}154 copy-clang-rst-docs155 )156 add_custom_target(generate-analyzer-options-rst DEPENDS ${aopts_rst})157 foreach(target ${docs_targets})158 add_dependencies(${target} generate-analyzer-options-rst)159 endforeach()160 161 # Technically this is redundant because generate-analyzer-options-rst162 # depends on the copy operation (because it wants to drop a generated file163 # into a subdirectory of the copied tree), but I'm leaving it here for the164 # sake of clarity.165 foreach(target ${docs_targets})166 add_dependencies(${target} copy-clang-rst-docs)167 endforeach()168 endif()169endif()170