mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
82048bd0c4
Currently the rst files have a bunch of warnings that cause build failures if you have sphinx installed. It sounds like these files are all on the path to being converted to markdown, so this loosens that restriction to not block folks from building.
76 lines
2.1 KiB
CMake
76 lines
2.1 KiB
CMake
add_subdirectory(tools)
|
|
|
|
find_program(SPHINX_EXECUTABLE
|
|
NAMES sphinx-build
|
|
HINTS $ENV{SPHINX_DIR}
|
|
PATH_SUFFIXES bin
|
|
DOC "Sphinx documentation generator")
|
|
|
|
SET(SWIFT_SPHINX_PAPER_SIZE "letter"
|
|
CACHE STRING "Paper size for generated documentation")
|
|
|
|
SET(SPHINX_ARGS
|
|
-D latex_elements.papersize=${SWIFT_SPHINX_PAPER_SIZE}
|
|
-d ${CMAKE_BINARY_DIR}/doctrees)
|
|
|
|
if(SPHINX_EXECUTABLE)
|
|
add_custom_target(docs_html ALL
|
|
${SPHINX_EXECUTABLE} ${SPHINX_ARGS} -b html
|
|
. ${CMAKE_BINARY_DIR}/docs/html
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
|
|
COMMENT "Building HTML documentation")
|
|
else()
|
|
message(WARNING "Unable to find sphinx-build program. Not building docs")
|
|
endif()
|
|
|
|
if (LLVM_ENABLE_DOXYGEN)
|
|
if (DOXYGEN_FOUND)
|
|
set(abs_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
|
|
set(abs_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()
|
|
|
|
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)
|
|
|
|
add_custom_target(doxygen-swift
|
|
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg
|
|
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
|
COMMENT "Generating swift doxygen documentation." VERBATIM)
|
|
|
|
if(LLVM_BUILD_DOCS)
|
|
add_dependencies(doxygen doxygen-swift)
|
|
endif()
|
|
|
|
add_dependencies(dev doxygen-swift)
|
|
swift_install_in_component(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/doxygen/html"
|
|
DESTINATION "docs/html"
|
|
COMPONENT dev)
|
|
endif()
|
|
endif()
|