mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-24 03:33:20 +01:00
0949b71567
The option LLVM_ENABLE_SPHINX option enables the "docs-llvm-html", "docs-llvm-man" targets but does not build them by default. The following CMake options have been added that control what targets are made available SPHINX_OUTPUT_HTML SPHINX_OUTPUT_MAN If LLVM_BUILD_DOCS is enabled then the enabled docs-llvm-* targets will be built by default and if ``make install`` is run then docs-llvm-html and docs-llvm-man will be installed (tested on Linux only). The add_sphinx_target function is in its own file so it can be included by other projects that use Sphinx for their documentation. Patch by Daniel Liew <daniel.liew@imperial.ac.uk>! llvm-svn: 206655
107 lines
3.5 KiB
CMake
107 lines
3.5 KiB
CMake
|
|
if (DOXYGEN_FOUND)
|
|
if (LLVM_ENABLE_DOXYGEN)
|
|
set(abs_top_srcdir ${LLVM_MAIN_SRC_DIR})
|
|
set(abs_top_builddir ${LLVM_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.
|
|
option(LLVM_ENABLE_DOXYGEN_QT_HELP
|
|
"Generate a Qt Compressed Help file." OFF)
|
|
if (LLVM_ENABLE_DOXYGEN_QT_HELP)
|
|
set(LLVM_DOXYGEN_QCH_FILENAME "org.llvm.qch" CACHE STRING
|
|
"Filename of the Qt Compressed help file")
|
|
set(LLVM_DOXYGEN_QHP_NAMESPACE "org.llvm" CACHE STRING
|
|
"Namespace under which the intermediate Qt Help Project file lives")
|
|
set(LLVM_DOXYGEN_QHP_CUST_FILTER_NAME "${PACKAGE_STRING}" CACHE STRING
|
|
"See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")
|
|
set(LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS "${PACKAGE_NAME},${PACKAGE_VERSION}" CACHE STRING
|
|
"See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")
|
|
find_program(LLVM_DOXYGEN_QHELPGENERATOR_PATH qhelpgenerator
|
|
DOC "Path to the qhelpgenerator binary")
|
|
if (NOT LLVM_DOXYGEN_QHELPGENERATOR_PATH)
|
|
message(FATAL_ERROR "Failed to find qhelpgenerator binary")
|
|
endif()
|
|
|
|
set(llvm_doxygen_generate_qhp "YES")
|
|
set(llvm_doxygen_qch_filename "${LLVM_DOXYGEN_QCH_FILENAME}")
|
|
set(llvm_doxygen_qhp_namespace "${LLVM_DOXYGEN_QHP_NAMESPACE}")
|
|
set(llvm_doxygen_qhelpgenerator_path "${LLVM_DOXYGEN_QHELPGENERATOR_PATH}")
|
|
set(llvm_doxygen_qhp_cust_filter_name "${LLVM_DOXYGEN_QHP_CUST_FILTER_NAME}")
|
|
set(llvm_doxygen_qhp_cust_filter_attrs "${LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS}")
|
|
|
|
else()
|
|
set(llvm_doxygen_generate_qhp "NO")
|
|
set(llvm_doxygen_qch_filename "")
|
|
set(llvm_doxygen_qhp_namespace "")
|
|
set(llvm_doxygen_qhelpgenerator_path "")
|
|
set(llvm_doxygen_qhp_cust_filter_name "")
|
|
set(llvm_doxygen_qhp_cust_filter_attrs "")
|
|
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(llvm_doxygen_generate_qhp)
|
|
set(llvm_doxygen_qch_filename)
|
|
set(llvm_doxygen_qhp_namespace)
|
|
set(llvm_doxygen_qhelpgenerator_path)
|
|
set(llvm_doxygen_qhp_cust_filter_name)
|
|
set(llvm_doxygen_qhp_cust_filter_attrs)
|
|
|
|
add_custom_target(doxygen-llvm
|
|
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
COMMENT "Generating llvm doxygen documentation." VERBATIM)
|
|
|
|
if (LLVM_BUILD_DOCS)
|
|
add_dependencies(doxygen doxygen-llvm)
|
|
endif()
|
|
|
|
if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
|
|
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html
|
|
DESTINATION docs/html)
|
|
endif()
|
|
endif()
|
|
endif()
|
|
|
|
if (LLVM_ENABLE_SPHINX)
|
|
if (SPHINX_FOUND)
|
|
include(AddSphinxTarget)
|
|
if (${SPHINX_OUTPUT_HTML})
|
|
add_sphinx_target(html llvm)
|
|
endif()
|
|
|
|
|
|
if (${SPHINX_OUTPUT_MAN})
|
|
add_sphinx_target(man llvm)
|
|
endif()
|
|
|
|
endif()
|
|
endif()
|