172 lines · plain
1 2find_package(Doxygen)3if (DOXYGEN_FOUND)4if (LLVM_ENABLE_DOXYGEN)5 set(abs_top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})6 set(abs_top_builddir ${CMAKE_CURRENT_BINARY_DIR})7 8 if (HAVE_DOT)9 set(DOT ${LLVM_PATH_DOT})10 endif()11 12 if (LLVM_DOXYGEN_EXTERNAL_SEARCH)13 set(enable_searchengine "YES")14 set(searchengine_url "${LLVM_DOXYGEN_SEARCHENGINE_URL}")15 set(enable_server_based_search "YES")16 set(enable_external_search "YES")17 set(extra_search_mappings "${LLVM_DOXYGEN_SEARCH_MAPPINGS}")18 else()19 set(enable_searchengine "NO")20 set(searchengine_url "")21 set(enable_server_based_search "NO")22 set(enable_external_search "NO")23 set(extra_search_mappings "")24 endif()25 26 # If asked, configure doxygen for the creation of a Qt Compressed Help file.27 if (LLVM_ENABLE_DOXYGEN_QT_HELP)28 set(FLANG_DOXYGEN_QCH_FILENAME "org.llvm.flang.qch" CACHE STRING29 "Filename of the Qt Compressed help file")30 set(FLANG_DOXYGEN_QHP_NAMESPACE "org.llvm.flang" CACHE STRING31 "Namespace under which the intermediate Qt Help Project file lives")32 set(FLANG_DOXYGEN_QHP_CUST_FILTER_NAME "FLANG ${FLANG_VERSION}" CACHE STRING33 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")34 set(FLANG_DOXYGEN_QHP_CUST_FILTER_ATTRS "FLANG,${FLANG_VERSION}" CACHE STRING35 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")36 set(flang_doxygen_generate_qhp "YES")37 set(flang_doxygen_qch_filename "${FLANG_DOXYGEN_QCH_FILENAME}")38 set(flang_doxygen_qhp_namespace "${FLANG_DOXYGEN_QHP_NAMESPACE}")39 set(flang_doxygen_qhelpgenerator_path "${LLVM_DOXYGEN_QHELPGENERATOR_PATH}")40 set(flang_doxygen_qhp_cust_filter_name "${FLANG_DOXYGEN_QHP_CUST_FILTER_NAME}")41 set(flang_doxygen_qhp_cust_filter_attrs "${FLANG_DOXYGEN_QHP_CUST_FILTER_ATTRS}")42 else()43 set(flang_doxygen_generate_qhp "NO")44 set(flang_doxygen_qch_filename "")45 set(flang_doxygen_qhp_namespace "")46 set(flang_doxygen_qhelpgenerator_path "")47 set(flang_doxygen_qhp_cust_filter_name "")48 set(flang_doxygen_qhp_cust_filter_attrs "")49 endif()50 51 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in52 ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY)53 54 set(abs_top_srcdir)55 set(abs_top_builddir)56 set(DOT)57 set(enable_searchengine)58 set(searchengine_url)59 set(enable_server_based_search)60 set(enable_external_search)61 set(extra_search_mappings)62 set(flang_doxygen_generate_qhp)63 set(flang_doxygen_qch_filename)64 set(flang_doxygen_qhp_namespace)65 set(flang_doxygen_qhelpgenerator_path)66 set(flang_doxygen_qhp_cust_filter_name)67 set(flang_doxygen_qhp_cust_filter_attrs)68 69 add_custom_target(doxygen-flang70 COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg71 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}72 COMMENT "Generating flang doxygen documentation." VERBATIM)73 set_target_properties(doxygen-flang PROPERTIES FOLDER "Flang/Docs")74 if (LLVM_BUILD_DOCS)75 add_dependencies(doxygen doxygen-flang)76 endif()77 78 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY AND LLVM_BUILD_DOCS)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 target)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 list(APPEND LLVM_TABLEGEN_FLAGS "-I${CMAKE_CURRENT_SOURCE_DIR}/../../clang/include/clang/Options/")92 clang_tablegen(Source/${output_file} ${td_option} SOURCE ${source} TARGET ${target})93endfunction()94 95if (LLVM_ENABLE_SPHINX)96 set (FLANG_DOCS_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/SourceHtml")97 set (FLANG_DOCS_MAN_DIR "${CMAKE_CURRENT_BINARY_DIR}/SourceMan")98 include(AddSphinxTarget)99 if (SPHINX_FOUND)100 101 # CLANG_TABLEGEN_EXE variable needs to be set for clang_tablegen to run without error102 find_program(CLANG_TABLEGEN_EXE "clang-tblgen" ${LLVM_TOOLS_BINARY_DIR} NO_DEFAULT_PATH)103 104 # Generate the RST file from TableGen (for both HTML and MAN builds)105 gen_rst_file_from_td(FlangCommandLineReference.rst -gen-opt-docs FlangOptionsDocs.td "gen-FlangCommandLineReference.rst")106 gen_rst_file_from_td(FlangCommandLineOptions.rst -gen-opt-docs FlangOptionsMan.td "gen-FlangCommandLineOptions.rst")107 # clang_tablegen() (called from gen_rst_file_from_td()) does not create the108 # output directory automatically, so we have to create it explicitly.109 add_custom_target(create-flang-rst-output-dir110 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/Source111 )112 add_dependencies("gen-FlangCommandLineReference.rst" create-flang-rst-output-dir)113 add_dependencies("gen-FlangCommandLineOptions.rst" create-flang-rst-output-dir)114 115 if (${SPHINX_OUTPUT_HTML})116 message(STATUS "Using index.md for html build")117 118 # Copy the entire flang/docs directory to the build Source dir,119 # then remove the index.rst file, to avoid clash with index.md120 # which is used for the HTML build.121 add_custom_target(copy-flang-src-docs-html122 COMMAND "${CMAKE_COMMAND}" -E copy_directory123 "${CMAKE_CURRENT_SOURCE_DIR}"124 "${FLANG_DOCS_HTML_DIR}"125 COMMAND "${CMAKE_COMMAND}" -E remove126 "${FLANG_DOCS_HTML_DIR}/CommandGuide/index.rst"127 COMMAND "${CMAKE_COMMAND}" -E copy128 "${CMAKE_CURRENT_BINARY_DIR}/Source/FlangCommandLineReference.rst"129 "${FLANG_DOCS_HTML_DIR}/FlangCommandLineReference.rst"130 DEPENDS flang-doc gen-FlangCommandLineReference.rst)131 132 # Run Python preprocessing ONLY for HTML build133 # This script prepends headers to FIRLangRef.md for proper formatting134 add_custom_command(TARGET copy-flang-src-docs-html135 COMMAND "${Python3_EXECUTABLE}"136 ARGS "${FLANG_DOCS_HTML_DIR}/FIR/CreateFIRLangRef.py")137 138 add_sphinx_target(html flang SOURCE_DIR "${FLANG_DOCS_HTML_DIR}")139 add_dependencies(docs-flang-html copy-flang-src-docs-html)140 endif()141 142 # ----------------------------143 # MAN BUILD SETUP144 # ----------------------------145 if (${SPHINX_OUTPUT_MAN})146 message(STATUS "Using CommandGuide/index.rst for man build")147 148 # Create minimal Source dir with ONLY the files needed for man build:149 # - conf.py (Sphinx config)150 # - index.rst (top-level man page)151 # - FlangCommandLineOptions.rst (generated reference)152 add_custom_target(copy-flang-src-docs-man153 COMMAND "${CMAKE_COMMAND}" -E make_directory154 "${FLANG_DOCS_MAN_DIR}"155 COMMAND "${CMAKE_COMMAND}" -E copy156 "${CMAKE_CURRENT_SOURCE_DIR}/conf.py"157 "${FLANG_DOCS_MAN_DIR}/conf.py"158 COMMAND "${CMAKE_COMMAND}" -E copy159 "${CMAKE_CURRENT_BINARY_DIR}/Source/FlangCommandLineOptions.rst"160 "${FLANG_DOCS_MAN_DIR}/FlangCommandLineOptions.rst"161 COMMAND "${CMAKE_COMMAND}" -E copy162 "${CMAKE_CURRENT_SOURCE_DIR}/CommandGuide/index.rst"163 "${FLANG_DOCS_MAN_DIR}/index.rst"164 DEPENDS flang-doc gen-FlangCommandLineOptions.rst)165 166 add_sphinx_target(man flang SOURCE_DIR "${FLANG_DOCS_MAN_DIR}")167 add_dependencies(docs-flang-man copy-flang-src-docs-man)168 endif()169 endif()170endif()171 172