Debian Codegraph @

docs/CMakeLists.txt

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