| 1 |
cmake_minimum_required (VERSION 3.10) |
| 2 |
|
| 3 |
find_package (Doxygen REQUIRED) |
| 4 |
set (QCH_INSTALL_DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/qt${QT_VERSION_MAJOR}/doc CACHE STRING "QCH install location") |
| 5 |
|
| 6 |
set (DOXYGEN_GENERATE_HTML YES CACHE STRING "Doxygen HTML output") |
| 7 |
set (DOXYGEN_GENERATE_XML YES CACHE STRING "Doxygen XML output") |
| 8 |
set (DOXYGEN_GENERATE_QHP YES CACHE STRING "Doxygen QHP output") |
| 9 |
set (DOXYGEN_FILE_PATTERNS *.cpp *.h *.zh_CN.md *.zh_CN.dox CACHE STRING "Doxygen File Patterns") |
| 10 |
set (DOXYGEN_PROJECT_NUMBER ${CMAKE_PROJECT_VERSION} CACHE STRING "") # Should be the same as this project is using. |
| 11 |
set (DOXYGEN_EXTRACT_STATIC YES) |
| 12 |
set (DOXYGEN_OUTPUT_LANGUAGE "Chinese") |
| 13 |
|
| 14 |
if("${QT_VERSION_MAJOR}" STREQUAL "5") |
| 15 |
find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Help) |
| 16 |
else() |
| 17 |
find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS ToolsTools) |
| 18 |
endif() |
| 19 |
get_target_property(_qhelpgenerator_location Qt${QT_VERSION_MAJOR}::qhelpgenerator IMPORTED_LOCATION) |
| 20 |
|
| 21 |
if("${_qhelpgenerator_location}" STREQUAL "") |
| 22 |
set(_qhelpgenerator_location "qhelpgenerator") |
| 23 |
endif() |
| 24 |
set (DOXYGEN_QHG_LOCATION ${_qhelpgenerator_location} CACHE STRING "Doxygen QHG path") |
| 25 |
|
| 26 |
set (DOXYGEN_QHP_NAMESPACE "org.deepin.dtk.core") |
| 27 |
set (DOXYGEN_QCH_FILE "dtkcore.qch") |
| 28 |
set (DOXYGEN_QHP_VIRTUAL_FOLDER "dtkcore") |
| 29 |
set (DOXYGEN_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/docs/) |
| 30 |
|
| 31 |
set (DOXYGEN_HTML_EXTRA_STYLESHEET "" CACHE STRING "Doxygen custom stylesheet for HTML output") |
| 32 |
set (DOXYGEN_TAGFILES "qtcore.tags=qthelp://org.qt-project.qtcore/qtcore/" CACHE STRING "Doxygen tag files") |
| 33 |
set (DOXYGEN_IMAGE_PATH ${PROJECT_SOURCE_DIR}/docs/src) |
| 34 |
set (DOXYGEN_SOURCE_BROWSE "YES") |
| 35 |
|
| 36 |
set (BUILD_THEME OFF CACHE BOOL "Build doxgen theme") |
| 37 |
if(BUILD_THEME) |
| 38 |
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/doxygen-theme") |
| 39 |
message(STATUS "doxygen-theme exists") |
| 40 |
else() |
| 41 |
execute_process(COMMAND git clone https://github.com/linuxdeepin/doxygen-theme.git --depth=1 |
| 42 |
WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR} |
| 43 |
TIMEOUT 60 |
| 44 |
) |
| 45 |
execute_process(COMMAND bash themesetting.sh |
| 46 |
WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/doxygen-theme/ |
| 47 |
) |
| 48 |
endif() |
| 49 |
set (DOXYGEN_HTML_EXTRA_STYLESHEET "docs/doxygen-theme/doxygen-awesome-css/doxygen-awesome.css" |
| 50 |
"docs/doxygen-theme/doxygen-awesome-css/doxygen-awesome-sidebar-only.css" |
| 51 |
"docs/doxygen-theme/doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css" |
| 52 |
) |
| 53 |
set (DOXYGEN_HTML_EXTRA_FILES "docs/doxygen-theme/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js" |
| 54 |
"docs/doxygen-theme/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js" |
| 55 |
"docs/doxygen-theme/doxygen-awesome-css/doxygen-awesome-paragraph-link.js" |
| 56 |
"docs/doxygen-theme/doxygen-awesome-css/doxygen-awesome-interactive-toc.js" |
| 57 |
) |
| 58 |
set (DOXYGEN_GENERATE_TREEVIEW "YES") |
| 59 |
set (DOXYGEN_DISABLE_INDEX "NO") |
| 60 |
set (DOXYGEN_FULL_SIDEBAR "NO") |
| 61 |
set (DOXYGEN_HTML_HEADER "docs/doxygen-theme/doxygen-awesome-css/header.html") |
| 62 |
set (DOXYGEN_HTML_FOOTER "docs/doxygen-theme/doxygen-awesome-css/footer.html") |
| 63 |
endif() |
| 64 |
|
| 65 |
set (DOXYGEN_MACRO_EXPANSION "YES") |
| 66 |
set (DOXYGEN_PREDEFINED |
| 67 |
"DCORE_BEGIN_NAMESPACE=namespace Dtk { namespace Core {" |
| 68 |
"DCORE_END_NAMESPACE=}}" |
| 69 |
"DCORE_USE_NAMESPACE=using namespace Dtk::Core;" |
| 70 |
"Q_OS_LINUX=1" |
| 71 |
) |
| 72 |
set (DOXYGEN_EXPAND_ONLY_PREDEF "YES") |
| 73 |
|
| 74 |
doxygen_add_docs (doxygen |
| 75 |
${PROJECT_SOURCE_DIR}/include |
| 76 |
${PROJECT_SOURCE_DIR}/docs |
| 77 |
ALL |
| 78 |
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} |
| 79 |
COMMENT "Generate documentation via Doxygen" |
| 80 |
) |
| 81 |
|
| 82 |
install (FILES ${PROJECT_BINARY_DIR}/docs/html/dtkcore.qch DESTINATION ${QCH_INSTALL_DESTINATION}) |