75c069584a
Add stub Sphinx documentation, with configuration copy-pasted from lld and index page converted from bolt/README.md. Reviewed By: #bolt, rafauler Differential Revision: https://reviews.llvm.org/D140156
103 lines
3.4 KiB
CMake
103 lines
3.4 KiB
CMake
|
|
find_package(Doxygen)
|
|
if (DOXYGEN_FOUND)
|
|
if (LLVM_ENABLE_DOXYGEN)
|
|
set(abs_top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
|
|
set(abs_top_builddir ${CMAKE_CURRENT_BINARY_DIR})
|
|
|
|
if (HAVE_DOT)
|
|
set(DOT ${LLVM_PATH_DOT})
|
|
endif()
|
|
|
|
if (LLVM_DOXYGEN_EXTERNAL_SEARCH)
|
|
set(enable_searchengine "YES")
|
|
set(searchengine_url "${LLVM_DOXYGEN_SEARCHENGINE_URL}")
|
|
set(enable_server_based_search "YES")
|
|
set(enable_external_search "YES")
|
|
set(extra_search_mappings "${LLVM_DOXYGEN_SEARCH_MAPPINGS}")
|
|
else()
|
|
set(enable_searchengine "NO")
|
|
set(searchengine_url "")
|
|
set(enable_server_based_search "NO")
|
|
set(enable_external_search "NO")
|
|
set(extra_search_mappings "")
|
|
endif()
|
|
|
|
# If asked, configure doxygen for the creation of a Qt Compressed Help file.
|
|
if (LLVM_ENABLE_DOXYGEN_QT_HELP)
|
|
set(BOLT_DOXYGEN_QCH_FILENAME "org.llvm.bolt.qch" CACHE STRING
|
|
"Filename of the Qt Compressed help file")
|
|
set(BOLT_DOXYGEN_QHP_NAMESPACE "org.llvm.bolt" CACHE STRING
|
|
"Namespace under which the intermediate Qt Help Project file lives")
|
|
set(BOLT_DOXYGEN_QHP_CUST_FILTER_NAME "Clang ${BOLT_VERSION}" CACHE STRING
|
|
"See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")
|
|
set(BOLT_DOXYGEN_QHP_CUST_FILTER_ATTRS "Clang,${BOLT_VERSION}" CACHE STRING
|
|
"See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")
|
|
set(bolt_doxygen_generate_qhp "YES")
|
|
set(bolt_doxygen_qch_filename "${BOLT_DOXYGEN_QCH_FILENAME}")
|
|
set(bolt_doxygen_qhp_namespace "${BOLT_DOXYGEN_QHP_NAMESPACE}")
|
|
set(bolt_doxygen_qhelpgenerator_path "${LLVM_DOXYGEN_QHELPGENERATOR_PATH}")
|
|
set(bolt_doxygen_qhp_cust_filter_name "${BOLT_DOXYGEN_QHP_CUST_FILTER_NAME}")
|
|
set(bolt_doxygen_qhp_cust_filter_attrs "${BOLT_DOXYGEN_QHP_CUST_FILTER_ATTRS}")
|
|
else()
|
|
set(bolt_doxygen_generate_qhp "NO")
|
|
set(bolt_doxygen_qch_filename "")
|
|
set(bolt_doxygen_qhp_namespace "")
|
|
set(bolt_doxygen_qhelpgenerator_path "")
|
|
set(bolt_doxygen_qhp_cust_filter_name "")
|
|
set(bolt_doxygen_qhp_cust_filter_attrs "")
|
|
endif()
|
|
|
|
option(LLVM_DOXYGEN_SVG
|
|
"Use svg instead of png files for doxygen graphs." OFF)
|
|
if (LLVM_DOXYGEN_SVG)
|
|
set(DOT_IMAGE_FORMAT "svg")
|
|
else()
|
|
set(DOT_IMAGE_FORMAT "png")
|
|
endif()
|
|
|
|
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in
|
|
${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY)
|
|
|
|
set(abs_top_srcdir)
|
|
set(abs_top_builddir)
|
|
set(DOT)
|
|
set(enable_searchengine)
|
|
set(searchengine_url)
|
|
set(enable_server_based_search)
|
|
set(enable_external_search)
|
|
set(extra_search_mappings)
|
|
set(bolt_doxygen_generate_qhp)
|
|
set(bolt_doxygen_qch_filename)
|
|
set(bolt_doxygen_qhp_namespace)
|
|
set(bolt_doxygen_qhelpgenerator_path)
|
|
set(bolt_doxygen_qhp_cust_filter_name)
|
|
set(bolt_doxygen_qhp_cust_filter_attrs)
|
|
set(DOT_IMAGE_FORMAT)
|
|
|
|
add_custom_target(doxygen-bolt
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
COMMENT "Generating bolt doxygen documentation." VERBATIM)
|
|
|
|
if (LLVM_BUILD_DOCS)
|
|
add_dependencies(doxygen doxygen-bolt)
|
|
endif()
|
|
|
|
if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY AND LLVM_BUILD_DOCS)
|
|
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html
|
|
DESTINATION docs/html)
|
|
endif()
|
|
endif()
|
|
endif()
|
|
|
|
if (LLVM_ENABLE_SPHINX)
|
|
include(AddSphinxTarget)
|
|
if (SPHINX_FOUND)
|
|
if (${SPHINX_OUTPUT_HTML})
|
|
add_sphinx_target(html bolt)
|
|
endif()
|
|
endif()
|
|
endif()
|
|
|