feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Docs: Add option to build docs by default

Browse Source 
Change-Id: I6cb8c2b163f5d01040952aecced287334d616976
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Marco Bubke
2024-06-18 15:09:15 +02:00
parent 6b8a41b1ba
commit dd962c2989
2 changed files with 27 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
cmake/QtCreatorDocumentation.cmake
View File

@@ -5,6 +5,18 @@ add_feature_info("Build documentation" WITH_DOCS "")
option(WITH_ONLINE_DOCS "Build online documentation" OFF) option(WITH_ONLINE_DOCS "Build online documentation" OFF)
add_feature_info("Build online documentation" WITH_ONLINE_DOCS "") add_feature_info("Build online documentation" WITH_ONLINE_DOCS "")
option(BUILD_DOCS_BY_DEFAULT "Build documentation by default" OFF)
add_feature_info("Build documentation by default" BUILD_DOCS_BY_DEFAULT "")
if (BUILD_DOCS_BY_DEFAULT)
set(EXCLUDE_DOCS_FROM_ALL "")
set(INCLUDE_DOCS_INTO_ALL "ALL")
else()
set(EXCLUDE_DOCS_FROM_ALL "EXCLUDE_FROM_ALL")
set(INCLUDE_DOCS_INTO_ALL "")
endif()
# Get information on directories from qmake # Get information on directories from qmake
# as this is not yet exported by cmake. # as this is not yet exported by cmake.
# Used for QT_INSTALL_DOCS # Used for QT_INSTALL_DOCS
@@ -46,13 +58,13 @@ endfunction()
function(_setup_doc_targets) function(_setup_doc_targets)
# Set up important targets: # Set up important targets:
if (NOT TARGET html_docs) if (NOT TARGET html_docs)
add_custom_target(html_docs COMMENT "Build HTML documentation") add_custom_target(html_docs ${INCLUDE_DOCS_INTO_ALL} COMMENT "Build HTML documentation")
endif() endif()
if (NOT TARGET qch_docs) if (NOT TARGET qch_docs)
add_custom_target(qch_docs COMMENT "Build QCH documentation") add_custom_target(qch_docs ${INCLUDE_DOCS_INTO_ALL} COMMENT "Build QCH documentation")
endif() endif()
if (NOT TARGET docs) if (NOT TARGET docs)
add_custom_target(docs COMMENT "Build documentation") add_custom_target(docs ${INCLUDE_DOCS_INTO_ALL} COMMENT "Build documentation")
add_dependencies(docs html_docs qch_docs) add_dependencies(docs html_docs qch_docs)
endif() endif()
endfunction() endfunction()
@@ -114,6 +126,7 @@ function(_setup_qdoc_targets _qdocconf_file _retval)
set(_html_target "html_docs_${_target}") set(_html_target "html_docs_${_target}")
add_custom_target("${_html_target}" add_custom_target("${_html_target}"
${INCLUDE_DOCS_INTO_ALL}
${_full_qdoc_command} -outputdir "${_html_outputdir}" "${_qdocconf_file}" ${_full_qdoc_command} -outputdir "${_html_outputdir}" "${_qdocconf_file}"
${_qdoc_index_args} ${_qdoc_include_args} ${_qdoc_index_args} ${_qdoc_include_args}
COMMENT "Build HTML documentation from ${_qdocconf_file}" COMMENT "Build HTML documentation from ${_qdocconf_file}"
@@ -126,7 +139,7 @@ function(_setup_qdoc_targets _qdocconf_file _retval)
# Install HTML files as a special component # Install HTML files as a special component
install(DIRECTORY "${_html_outputdir}" DESTINATION "${_arg_INSTALL_DIR}" install(DIRECTORY "${_html_outputdir}" DESTINATION "${_arg_INSTALL_DIR}"
COMPONENT html_docs EXCLUDE_FROM_ALL) COMPONENT html_docs ${EXCLUDE_DOCS_FROM_ALL})
set("${_retval}" "${_html_outputdir}" PARENT_SCOPE) set("${_retval}" "${_html_outputdir}" PARENT_SCOPE)
endfunction() endfunction()
@@ -154,6 +167,7 @@ function(_setup_qhelpgenerator_targets _qdocconf_file _html_outputdir)
set(_qch_target "qch_docs_${_target}") set(_qch_target "qch_docs_${_target}")
set(_html_target "html_docs_${_target}") set(_html_target "html_docs_${_target}")
add_custom_target("${_qch_target}" add_custom_target("${_qch_target}"
${INCLUDE_DOCS_INTO_ALL}
Qt::qhelpgenerator "${_html_outputdir}/${_target}.qhp" -o "${_qch_outputdir}/${_target}.qch" Qt::qhelpgenerator "${_html_outputdir}/${_target}.qhp" -o "${_qch_outputdir}/${_target}.qch"
COMMENT "Build QCH documentation from ${_qdocconf_file}" COMMENT "Build QCH documentation from ${_qdocconf_file}"
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
@@ -163,7 +177,7 @@ function(_setup_qhelpgenerator_targets _qdocconf_file _html_outputdir)
add_dependencies(qch_docs "${_qch_target}") add_dependencies(qch_docs "${_qch_target}")
install(FILES "${_qch_outputdir}/${_target}.qch" DESTINATION "${_arg_INSTALL_DIR}" install(FILES "${_qch_outputdir}/${_target}.qch" DESTINATION "${_arg_INSTALL_DIR}"
COMPONENT qch_docs EXCLUDE_FROM_ALL) COMPONENT qch_docs ${EXCLUDE_DOCS_FROM_ALL})
endfunction() endfunction()
# Helper functions: # Helper functions:
@@ -283,6 +297,7 @@ function(add_qtc_doc_attribution target attribution_file output_file qdocconf_fi
file(MAKE_DIRECTORY ${output_dir}) file(MAKE_DIRECTORY ${output_dir})
# add target # add target
add_custom_target(${target} add_custom_target(${target}
${INCLUDE_DOCS_INTO_ALL}
Qt6::qtattributionsscanner -o "${output_file}" --basedir "${PROJECT_SOURCE_DIR}" ${attribution_file} Qt6::qtattributionsscanner -o "${output_file}" --basedir "${PROJECT_SOURCE_DIR}" ${attribution_file}
COMMENT "Create attributions ${output_file} from ${attribution_file}" COMMENT "Create attributions ${output_file} from ${attribution_file}"
DEPENDS "${attribution_file}" DEPENDS "${attribution_file}"

8
doc/CMakeLists.txt
View File

@@ -67,8 +67,14 @@ if(WITH_ONLINE_DOCS)
_add_doc(${IDE_DOC_FILE_ONLINE} "qtcreatordev/qtcreator-dev-online.qdocconf") _add_doc(${IDE_DOC_FILE_ONLINE} "qtcreatordev/qtcreator-dev-online.qdocconf")
endif() endif()
if (BUILD_DOCS_BY_DEFAULT)
set(EXCLUDE_DOCS_FROM_ALL "")
else()
set(EXCLUDE_DOCS_FROM_ALL "EXCLUDE_FROM_ALL")
endif()
install(DIRECTORY config install(DIRECTORY config
DESTINATION ${IDE_HEADER_INSTALL_PATH}/doc DESTINATION ${IDE_HEADER_INSTALL_PATH}/doc
COMPONENT Devel COMPONENT Devel
EXCLUDE_FROM_ALL ${EXCLUDE_DOCS_FROM_ALL}
) )