From 8e75846a91b71cc30a18edea64ba4fa7c3b7e4e0 Mon Sep 17 00:00:00 2001 From: Andrey Astafyev Date: Tue, 3 Dec 2019 19:20:42 +0300 Subject: [PATCH] =?UTF-8?q?=D0=A4=D1=83=D0=BD=D0=BA=D1=86=D0=B8=D0=B8=20?= =?UTF-8?q?=D0=B4=D0=BB=D1=8F=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD?= =?UTF-8?q?=D1=82=D0=B0=D1=86=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CMLibDocBreathe.cmake | 90 ++++++++++++++++++++++--------------------- CMLibDocDoxygen.cmake | 52 ++++++++++++------------- 2 files changed, 71 insertions(+), 71 deletions(-) diff --git a/CMLibDocBreathe.cmake b/CMLibDocBreathe.cmake index f20a676..0ef1b3d 100644 --- a/CMLibDocBreathe.cmake +++ b/CMLibDocBreathe.cmake @@ -1,19 +1,11 @@ -set(BREATHE_FOUND AUTO CACHE STRING "Enable Breathe documentation generator") -set_property(CACHE BREATHE_FOUND - PROPERTY STRINGS - ON - OFF - AUTO) +set(BREATHE_FOUND + AUTO + CACHE STRING "Enable Breathe documentation generator") +set_property(CACHE BREATHE_FOUND PROPERTY STRINGS ON OFF AUTO) find_package(Doxygen) find_package(Perl) -set(Python_ADDITIONAL_VERSIONS - 3.7 - 3.6 - 3.5 - 3.4 - 3.3 - 3.2) +set(Python_ADDITIONAL_VERSIONS 3.7 3.6 3.5 3.4 3.3 3.2) find_package(PythonInterp) if(PYTHONINTERP_FOUND) find_package(Sphinx) @@ -26,53 +18,65 @@ if(PYTHONINTERP_FOUND) AND SPHINX_EXECUTABLE AND breathe AND recommonmark) - set(BREATHE_FOUND ON CACHE STRING "Breathe documentation generator enabled" FORCE) + set(BREATHE_FOUND + ON + CACHE STRING "Breathe documentation generator enabled" FORCE) else() - set(BREATHE_FOUND OFF CACHE STRING "Breathe documentation generator disabled" FORCE) + set(BREATHE_FOUND + OFF + CACHE STRING "Breathe documentation generator disabled" FORCE) endif() else() - set(BREATHE_FOUND OFF CACHE STRING "Breathe documentation generator disabled" FORCE) + set(BREATHE_FOUND + OFF + CACHE STRING "Breathe documentation generator disabled" FORCE) endif() function(add_breathe_target) set(options) - set(oneValueArgs - TARGET_NAME - SOURCE_DIR - DOXY_FILE - CONF_FILE - OUTPUT_DIR - COMMENT) + set(oneValueArgs TARGET_NAME COMMENT) set(multiValueArgs) - cmake_parse_arguments(_BREATHE - "${options}" - "${oneValueArgs}" - "${multiValueArgs}" - ${ARGN}) + cmake_parse_arguments(_BREATHE "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) if(BREATHE_FOUND) set(WORK_DIR ${CMAKE_BINARY_DIR}/_breathe) set(BREATHE_DOCS_BUILD_DIR ${WORK_DIR}) set(GENERATE_XML YES) set(GENERATE_HTML NO) set(GENERATE_LATEX NO) - set(OUTPUT_DIRECTORY ${WORK_DIR}) + set(GENERATE_SQLITE NO) + set(CONF_FILE ${CMAKE_SOURCE_DIR}/cmake/doc/breathe-conf.py.in) + set(DOXY_FILE ${CMAKE_SOURCE_DIR}/cmake/doc/Doxyfile.in) - configure_file(${_BREATHE_CONF_FILE} ${WORK_DIR}/conf.py @ONLY) - configure_file(${_BREATHE_DOXY_FILE} ${WORK_DIR}/Doxyfile @ONLY) + configure_file(${CONF_FILE} ${WORK_DIR}/conf.py @ONLY) + configure_file(${DOXY_FILE} ${WORK_DIR}/Doxyfile @ONLY) - add_custom_target(${_BREATHE_TARGET_NAME} VERBATIM - COMMAND ${SPHINX_EXECUTABLE} - -q - -b - html - -c - ${WORK_DIR} - -d - ${WORK_DIR}/cache - ${_BREATHE_SOURCE_DIR} - ${_BREATHE_OUTPUT_DIR} - COMMENT "Building ${_BREATHE_TARGET_NAME} documentation with Breathe") + add_custom_target( + ${_BREATHE_TARGET_NAME} VERBATIM + COMMAND + ${SPHINX_EXECUTABLE} -q -b html -c ${WORK_DIR} -d ${WORK_DIR}/cache ${WORK_DIR} + ${CMAKE_BINARY_DIR}/doc/breathe + COMMENT "Building ${_BREATHE_TARGET_NAME} documentation with Breathe") + + set(INDEX_MD_FILE ${CMAKE_SOURCE_DIR}/doc/breathe/index.md.in) + if(EXISTS ${INDEX_MD_FILE}) + configure_file(${INDEX_MD_FILE} ${WORK_DIR}/index.md @ONLY) + file(GLOB MD_FILES ${CMAKE_SOURCE_DIR}/doc/breathe/*.md) + if(MD_FILES) + add_custom_command(TARGET ${_BREATHE_TARGET_NAME} PRE_BUILD + COMMAND ${CMAKE_COMMAND} -E copy_if_different ${MD_FILES} ${WORK_DIR}) + endif() + endif() + + set(INDEX_RST_FILE ${CMAKE_SOURCE_DIR}/doc/breathe/index.rst.in) + if(EXISTS ${INDEX_RST_FILE}) + configure_file(${INDEX_RST_FILE} ${WORK_DIR}/index.rst @ONLY) + file(GLOB RST_FILES ${CMAKE_SOURCE_DIR}/doc/breathe/*.rst) + if(RST_FILES) + add_custom_command(TARGET ${_BREATHE_TARGET_NAME} PRE_BUILD + COMMAND ${CMAKE_COMMAND} -E copy_if_different ${RST_FILES} ${WORK_DIR}) + endif() + endif() else() add_custom_target(${_BREATHE_TARGET_NAME} VERBATIM COMMENT "Breathe is not found. Skipping target ${_BREATHE_TARGET_NAME} build") diff --git a/CMLibDocDoxygen.cmake b/CMLibDocDoxygen.cmake index a04be27..040da3f 100644 --- a/CMLibDocDoxygen.cmake +++ b/CMLibDocDoxygen.cmake @@ -1,53 +1,49 @@ -set(DOXYGEN_FOUND AUTO CACHE STRING "Enable Doxygen documentation generator") -set_property(CACHE DOXYGEN_FOUND - PROPERTY STRINGS - ON - OFF - AUTO) +set(DOXYGEN_FOUND + AUTO + CACHE STRING "Enable Doxygen documentation generator") +set_property(CACHE DOXYGEN_FOUND PROPERTY STRINGS ON OFF AUTO) find_package(Doxygen) if(DOXYGEN_FOUND) - set(DOXYGEN_FOUND ON CACHE STRING "Doxygen documentation generator enabled" FORCE) + set(DOXYGEN_FOUND + ON + CACHE STRING "Doxygen documentation generator enabled" FORCE) else() - set(DOXYGEN_FOUND OFF CACHE STRING "Doxygen documentation generator disabled" FORCE) + set(DOXYGEN_FOUND + OFF + CACHE STRING "Doxygen documentation generator disabled" FORCE) endif() function(add_doxygen_target) set(options) - set(oneValueArgs - TARGET_NAME - SOURCE_DIR - DOXY_FILE - OUTPUT_DIR - LATEX - HTML) + set(oneValueArgs TARGET_NAME SQLITE LATEX HTML) set(multiValueArgs) - cmake_parse_arguments(_DOXYGEN - "${options}" - "${oneValueArgs}" - "${multiValueArgs}" - ${ARGN}) + cmake_parse_arguments(_DOXYGEN "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) if(DOXYGEN_FOUND) set(GENERATE_XML NO) set(GENERATE_HTML NO) set(GENERATE_LATEX NO) - set(OUTPUT_DIRECTORY ${_DOXYGEN_OUTPUT_DIR}) - set(SOURCE_DIR ${_DOXYGEN_SOURCE_DIR}) + set(GENERATE_SQLITE YES) if(_DOXYGEN_HTML) set(GENERATE_HTML YES) endif() if(_DOXYGEN_LATEX) set(GENERATE_LATEX YES) endif() + if(_DOXYGEN_SQLITE) + set(GENERATE_SQLITE YES) + endif() - set(WORK_DIR ${CMAKE_BINARY_DIR}/_doxygen) - configure_file(${_DOXYGEN_DOXY_FILE} ${WORK_DIR}/Doxyfile @ONLY) + set(WORK_DIR ${CMAKE_BINARY_DIR}/doc/doxygen) + configure_file(${CMAKE_SOURCE_DIR}/cmake/doc/Doxyfile.in ${WORK_DIR}/Doxyfile @ONLY) - add_custom_target(${_DOXYGEN_TARGET_NAME} VERBATIM - COMMAND ${DOXYGEN_EXECUTABLE} ${WORK_DIR}/Doxyfile - WORKING_DIRECTORY ${WORK_DIR} - COMMENT "Generating API documentation with Doxygen") + add_custom_target( + ${_DOXYGEN_TARGET_NAME} VERBATIM + COMMAND "${CMAKE_COMMAND}" -E remove -f "${WORK_DIR}/doxygen_sqlite3.db" + COMMAND ${DOXYGEN_EXECUTABLE} ${WORK_DIR}/Doxyfile + WORKING_DIRECTORY ${WORK_DIR} + COMMENT "Generating API documentation with Doxygen") else() add_custom_target(${_DOXYGEN_TARGET_NAME} VERBATIM COMMENT "Doxygen is not found. Skipping target ${_DOXYGEN_TARGET_NAME} build")