diff options
author | Stephen Hines <srhines@google.com> | 2014-05-29 02:49:00 -0700 |
---|---|---|
committer | Stephen Hines <srhines@google.com> | 2014-05-29 02:49:00 -0700 |
commit | dce4a407a24b04eebc6a376f8e62b41aaa7b071f (patch) | |
tree | dcebc53f2b182f145a2e659393bf9a0472cedf23 /cmake/modules/AddSphinxTarget.cmake | |
parent | 220b921aed042f9e520c26cffd8282a94c66c3d5 (diff) | |
download | external_llvm-dce4a407a24b04eebc6a376f8e62b41aaa7b071f.zip external_llvm-dce4a407a24b04eebc6a376f8e62b41aaa7b071f.tar.gz external_llvm-dce4a407a24b04eebc6a376f8e62b41aaa7b071f.tar.bz2 |
Update LLVM for 3.5 rebase (r209712).
Change-Id: I149556c940fb7dc92d075273c87ff584f400941f
Diffstat (limited to 'cmake/modules/AddSphinxTarget.cmake')
-rw-r--r-- | cmake/modules/AddSphinxTarget.cmake | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/cmake/modules/AddSphinxTarget.cmake b/cmake/modules/AddSphinxTarget.cmake new file mode 100644 index 0000000..fc28a49 --- /dev/null +++ b/cmake/modules/AddSphinxTarget.cmake @@ -0,0 +1,56 @@ +# Handy function for creating the different Sphinx targets. +# +# ``builder`` should be one of the supported builders used by +# the sphinx-build command. +# +# ``project`` should be the project name +function (add_sphinx_target builder project) + set(SPHINX_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/${builder}") + set(SPHINX_DOC_TREE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees") + set(SPHINX_TARGET_NAME docs-${project}-${builder}) + add_custom_target(${SPHINX_TARGET_NAME} + COMMAND ${SPHINX_EXECUTABLE} + -b ${builder} + -d "${SPHINX_DOC_TREE_DIR}" + -q # Quiet: no output other than errors and warnings. + -W # Warnings are errors. + "${CMAKE_CURRENT_SOURCE_DIR}" # Source + "${SPHINX_BUILD_DIR}" # Output + COMMENT + "Generating ${builder} Sphinx documentation for ${project}") + + # When "clean" target is run, remove the Sphinx build directory + set_property(DIRECTORY APPEND PROPERTY + ADDITIONAL_MAKE_CLEAN_FILES + "${SPHINX_BUILD_DIR}") + + # We need to remove ${SPHINX_DOC_TREE_DIR} when make clean is run + # but we should only add this path once + get_property(_CURRENT_MAKE_CLEAN_FILES + DIRECTORY PROPERTY ADDITIONAL_MAKE_CLEAN_FILES) + list(FIND _CURRENT_MAKE_CLEAN_FILES "${SPHINX_DOC_TREE_DIR}" _INDEX) + if (_INDEX EQUAL -1) + set_property(DIRECTORY APPEND PROPERTY + ADDITIONAL_MAKE_CLEAN_FILES + "${SPHINX_DOC_TREE_DIR}") + endif() + + if (LLVM_BUILD_DOCS) + add_dependencies(sphinx ${SPHINX_TARGET_NAME}) + + # Handle installation + if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY) + if (builder STREQUAL man) + # FIXME: We might not ship all the tools that these man pages describe + install(DIRECTORY "${SPHINX_BUILD_DIR}/" # Slash indicates contents of + DESTINATION share/man/man1) + + elseif (builder STREQUAL html) + install(DIRECTORY "${SPHINX_BUILD_DIR}" + DESTINATION "share/doc/${project}") + else() + message(WARNING Installation of ${builder} not supported) + endif() + endif() + endif() +endfunction() |