2020-04-11 07:12:20 +00:00
|
|
|
set(BREATHE_FOUND AUTO CACHE STRING "Enable Breathe documentation generator")
|
2019-12-03 16:20:42 +00:00
|
|
|
set_property(CACHE BREATHE_FOUND PROPERTY STRINGS ON OFF AUTO)
|
2019-08-17 08:19:08 +00:00
|
|
|
|
|
|
|
find_package(Doxygen)
|
|
|
|
find_package(Perl)
|
2020-04-11 07:12:20 +00:00
|
|
|
set(Python_ADDITIONAL_VERSIONS 3.8;3.7;3.6;3.5;3.4;3.3;3.2)
|
2019-08-17 08:19:08 +00:00
|
|
|
find_package(PythonInterp)
|
2019-10-07 10:52:50 +00:00
|
|
|
if(PYTHONINTERP_FOUND)
|
2019-08-17 08:19:08 +00:00
|
|
|
find_package(Sphinx)
|
|
|
|
include(FindPythonModule)
|
|
|
|
find_python_module(breathe)
|
|
|
|
find_python_module(recommonmark)
|
2019-10-07 10:52:50 +00:00
|
|
|
if(DOXYGEN_FOUND
|
|
|
|
AND PERL_FOUND
|
|
|
|
AND PYTHONINTERP_FOUND
|
|
|
|
AND SPHINX_EXECUTABLE
|
|
|
|
AND breathe
|
|
|
|
AND recommonmark)
|
2020-04-11 07:12:20 +00:00
|
|
|
set(BREATHE_FOUND ON CACHE STRING "Breathe documentation generator enabled" FORCE)
|
2019-08-17 08:19:08 +00:00
|
|
|
else()
|
2020-04-11 07:12:20 +00:00
|
|
|
set(BREATHE_FOUND OFF CACHE STRING "Breathe documentation generator disabled" FORCE)
|
2019-08-17 08:19:08 +00:00
|
|
|
endif()
|
|
|
|
else()
|
2020-04-11 07:12:20 +00:00
|
|
|
set(BREATHE_FOUND OFF CACHE STRING "Breathe documentation generator disabled" FORCE)
|
2019-08-17 08:19:08 +00:00
|
|
|
endif()
|
2019-03-31 10:52:29 +00:00
|
|
|
|
2020-04-13 16:44:42 +00:00
|
|
|
function(add_breathe target)
|
2019-10-07 08:43:32 +00:00
|
|
|
set(options)
|
2020-04-13 16:44:42 +00:00
|
|
|
set(oneValueArgs COMMENT)
|
2019-10-07 08:43:32 +00:00
|
|
|
set(multiValueArgs)
|
2019-02-20 20:25:23 +00:00
|
|
|
|
2020-04-01 18:42:59 +00:00
|
|
|
cmake_parse_arguments(_BREATHE "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
|
2019-10-07 08:43:32 +00:00
|
|
|
if(BREATHE_FOUND)
|
2019-10-13 06:13:51 +00:00
|
|
|
set(WORK_DIR ${CMAKE_BINARY_DIR}/_breathe)
|
|
|
|
set(BREATHE_DOCS_BUILD_DIR ${WORK_DIR})
|
2019-10-05 13:31:57 +00:00
|
|
|
set(GENERATE_XML YES)
|
|
|
|
set(GENERATE_HTML NO)
|
|
|
|
set(GENERATE_LATEX NO)
|
2019-12-03 16:20:42 +00:00
|
|
|
set(CONF_FILE ${CMAKE_SOURCE_DIR}/cmake/doc/breathe-conf.py.in)
|
|
|
|
set(DOXY_FILE ${CMAKE_SOURCE_DIR}/cmake/doc/Doxyfile.in)
|
2019-02-20 20:25:23 +00:00
|
|
|
|
2019-12-03 16:20:42 +00:00
|
|
|
configure_file(${CONF_FILE} ${WORK_DIR}/conf.py @ONLY)
|
|
|
|
configure_file(${DOXY_FILE} ${WORK_DIR}/Doxyfile @ONLY)
|
2019-02-20 20:25:23 +00:00
|
|
|
|
2019-12-03 16:20:42 +00:00
|
|
|
add_custom_target(
|
2020-04-13 16:44:42 +00:00
|
|
|
${target}
|
2020-03-29 05:44:48 +00:00
|
|
|
VERBATIM
|
2020-04-01 18:42:59 +00:00
|
|
|
COMMAND ${SPHINX_EXECUTABLE} -q -b html -c ${WORK_DIR} -d ${WORK_DIR}/cache ${WORK_DIR}
|
|
|
|
${CMAKE_BINARY_DIR}/doc/breathe
|
2020-04-13 16:44:42 +00:00
|
|
|
COMMENT "Building ${target} documentation with Breathe")
|
2019-12-03 16:20:42 +00:00
|
|
|
|
|
|
|
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)
|
2020-04-14 09:20:01 +00:00
|
|
|
add_custom_command(TARGET ${target} PRE_BUILD COMMAND ${CMAKE_COMMAND} -E copy_if_different
|
|
|
|
${MD_FILES} ${WORK_DIR})
|
2019-12-03 16:20:42 +00:00
|
|
|
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)
|
2020-04-14 09:20:01 +00:00
|
|
|
add_custom_command(TARGET ${target} PRE_BUILD COMMAND ${CMAKE_COMMAND} -E copy_if_different
|
|
|
|
${RST_FILES} ${WORK_DIR})
|
2019-12-03 16:20:42 +00:00
|
|
|
endif()
|
|
|
|
endif()
|
2019-08-17 08:19:08 +00:00
|
|
|
else()
|
2020-04-13 16:44:42 +00:00
|
|
|
message(STATUS "CMLIB warning:")
|
2020-04-14 09:20:01 +00:00
|
|
|
add_custom_target(${target} VERBATIM COMMENT " Breathe is not found. Skipping target ${target} build")
|
2019-03-31 10:52:29 +00:00
|
|
|
endif()
|
2019-02-20 20:25:23 +00:00
|
|
|
endfunction()
|