3a572290cc
Assistant in Qt 4.8 does not handle css import paths relative to the includer. This is fixed in Qt 4.8 commit b95750a275 (Assistant: Set the url on created QNetworkReply objects., 2014-03-31). It is unknown whether there will be a further Qt 4.8 release containing that commit. Use a CMake script to pre-replace the content prior to generating the qch file. An alternative workaround of moving the files or adding "_static" to the import path did not seem to work for existing Qt 4.8 versions. The bug was fixed in the Qt 5 branch before Qt 5.0. The Qt 5 assistant renders this workaround'ed version correctly too.
151 lines
4.9 KiB
CMake
151 lines
4.9 KiB
CMake
#=============================================================================
|
|
# CMake - Cross Platform Makefile Generator
|
|
# Copyright 2000-2013 Kitware, Inc., Insight Software Consortium
|
|
#
|
|
# Distributed under the OSI-approved BSD License (the "License");
|
|
# see accompanying file Copyright.txt for details.
|
|
#
|
|
# This software is distributed WITHOUT ANY WARRANTY; without even the
|
|
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
# See the License for more information.
|
|
#=============================================================================
|
|
if(NOT CMake_SOURCE_DIR)
|
|
set(CMakeHelp_STANDALONE 1)
|
|
cmake_minimum_required(VERSION 2.8.4 FATAL_ERROR)
|
|
get_filename_component(tmp "${CMAKE_CURRENT_SOURCE_DIR}" PATH)
|
|
get_filename_component(CMake_SOURCE_DIR "${tmp}" PATH)
|
|
include(${CMake_SOURCE_DIR}/Modules/CTestUseLaunchers.cmake)
|
|
include(${CMake_SOURCE_DIR}/Source/CMakeVersionCompute.cmake)
|
|
include(${CMake_SOURCE_DIR}/Source/CMakeInstallDestinations.cmake)
|
|
unset(CMAKE_DATA_DIR)
|
|
unset(CMAKE_DATA_DIR CACHE)
|
|
endif()
|
|
project(CMakeHelp NONE)
|
|
|
|
option(SPHINX_MAN "Build man pages with Sphinx" OFF)
|
|
option(SPHINX_HTML "Build html help with Sphinx" OFF)
|
|
option(SPHINX_QTHELP "Build Qt help with Sphinx" OFF)
|
|
option(SPHINX_TEXT "Build text help with Sphinx (not installed)" OFF)
|
|
find_program(SPHINX_EXECUTABLE
|
|
NAMES sphinx-build
|
|
DOC "Sphinx Documentation Builder (sphinx-doc.org)"
|
|
)
|
|
|
|
mark_as_advanced(SPHINX_TEXT)
|
|
|
|
if(NOT SPHINX_MAN AND NOT SPHINX_HTML AND NOT SPHINX_QTHELP AND NOT SPHINX_TEXT)
|
|
return()
|
|
elseif(NOT SPHINX_EXECUTABLE)
|
|
message(FATAL_ERROR "SPHINX_EXECUTABLE (sphinx-build) is not found!")
|
|
endif()
|
|
|
|
set(copyright_line_regex "^Copyright (2000-20[0-9][0-9] Kitware.*)")
|
|
file(STRINGS "${CMake_SOURCE_DIR}/Copyright.txt" copyright_line
|
|
LIMIT_COUNT 1 REGEX "${copyright_line_regex}")
|
|
if(copyright_line MATCHES "${copyright_line_regex}")
|
|
set(conf_copyright "${CMAKE_MATCH_1}")
|
|
else()
|
|
set(conf_copyright "Kitware, Inc.")
|
|
endif()
|
|
|
|
set(conf_docs "${CMake_SOURCE_DIR}/Help")
|
|
set(conf_path "${CMAKE_CURRENT_SOURCE_DIR}")
|
|
set(conf_version "${CMake_VERSION_MAJOR}.${CMake_VERSION_MINOR}.${CMake_VERSION_PATCH}")
|
|
set(conf_release "${CMake_VERSION}")
|
|
configure_file(conf.py.in conf.py @ONLY)
|
|
|
|
set(doc_formats "")
|
|
if(SPHINX_HTML)
|
|
list(APPEND doc_formats html)
|
|
endif()
|
|
if(SPHINX_MAN)
|
|
list(APPEND doc_formats man)
|
|
endif()
|
|
if(SPHINX_TEXT)
|
|
list(APPEND doc_formats text)
|
|
endif()
|
|
if(SPHINX_QTHELP)
|
|
find_program(QCOLLECTIONGENERATOR_EXECUTABLE
|
|
NAMES qcollectiongenerator
|
|
DOC "qcollectiongenerator tool"
|
|
)
|
|
if (NOT QCOLLECTIONGENERATOR_EXECUTABLE)
|
|
message(FATAL_ERROR "QCOLLECTIONGENERATOR_EXECUTABLE (qcollectiongenerator) not found!")
|
|
endif()
|
|
list(APPEND doc_formats qthelp)
|
|
|
|
set(qthelp_extra_commands
|
|
# Workaround for assistant prior to
|
|
# https://codereview.qt-project.org/#change,82250 in Qt 4.
|
|
COMMAND ${CMAKE_COMMAND} "-DCSS_DIR=${CMAKE_CURRENT_BINARY_DIR}/qthelp/_static"
|
|
-P "${CMAKE_CURRENT_SOURCE_DIR}/apply_qthelp_css_workaround.cmake"
|
|
COMMAND qcollectiongenerator ${CMAKE_CURRENT_BINARY_DIR}/qthelp/CMake.qhcp
|
|
)
|
|
endif()
|
|
|
|
|
|
set(doc_format_outputs "")
|
|
set(doc_format_last "")
|
|
foreach(format ${doc_formats})
|
|
set(doc_format_output "doc_format_${format}")
|
|
set(doc_format_log "build-${format}.log")
|
|
add_custom_command(
|
|
OUTPUT ${doc_format_output}
|
|
COMMAND ${SPHINX_EXECUTABLE}
|
|
-c ${CMAKE_CURRENT_BINARY_DIR}
|
|
-d ${CMAKE_CURRENT_BINARY_DIR}/doctrees
|
|
-b ${format}
|
|
${CMake_SOURCE_DIR}/Help
|
|
${CMAKE_CURRENT_BINARY_DIR}/${format}
|
|
> ${doc_format_log} # log stdout, pass stderr
|
|
${${format}_extra_commands}
|
|
DEPENDS ${doc_format_last}
|
|
COMMENT "sphinx-build ${format}: see Utilities/Sphinx/${doc_format_log}"
|
|
VERBATIM
|
|
)
|
|
set_property(SOURCE ${doc_format_output} PROPERTY SYMBOLIC 1)
|
|
list(APPEND doc_format_outputs ${doc_format_output})
|
|
set(doc_format_last ${doc_format_output})
|
|
endforeach()
|
|
|
|
add_custom_target(documentation ALL DEPENDS ${doc_format_outputs})
|
|
|
|
foreach(t
|
|
cmake
|
|
ccmake
|
|
cmake-gui
|
|
cpack
|
|
ctest
|
|
)
|
|
if(TARGET ${t})
|
|
# Build documentation after main executables.
|
|
add_dependencies(documentation ${t})
|
|
endif()
|
|
endforeach()
|
|
|
|
if(SPHINX_MAN)
|
|
file(GLOB man_rst RELATIVE ${CMake_SOURCE_DIR}/Help/manual
|
|
${CMake_SOURCE_DIR}/Help/manual/*.[1-9].rst)
|
|
foreach(m ${man_rst})
|
|
if("x${m}" MATCHES "^x(.+)\\.([1-9])\\.rst$")
|
|
set(name "${CMAKE_MATCH_1}")
|
|
set(sec "${CMAKE_MATCH_2}")
|
|
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/${name}.${sec}
|
|
DESTINATION ${CMAKE_MAN_DIR}/man${sec})
|
|
endif()
|
|
endforeach()
|
|
endif()
|
|
|
|
if(SPHINX_HTML)
|
|
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
|
|
DESTINATION ${CMAKE_DOC_DIR}
|
|
PATTERN .buildinfo EXCLUDE
|
|
PATTERN objects.inv EXCLUDE
|
|
)
|
|
endif()
|
|
if(SPHINX_QTHELP)
|
|
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/qthelp/CMake.qch
|
|
DESTINATION ${CMAKE_DOC_DIR}
|
|
)
|
|
endif()
|