From d0c66b03a6cd9ce1f1932b79bf52fd366d2c1618 Mon Sep 17 00:00:00 2001 From: chenhongtao Date: Fri, 26 Aug 2022 15:32:34 +0800 Subject: [PATCH] feat(doc): add package for doc build the package for doc Log: build package of doc --- CMakeLists.txt | 2 +- archlinux/PKGBUILD | 3 ++- debian/control | 10 +++++++++- debian/libdtkcore-doc.install | 1 + debian/rules | 2 +- {doc => docs}/CMakeLists.txt | 11 +++++------ {doc => docs}/Specification.md | 0 {doc => docs}/src/dtkcore-index.qdoc | 0 {doc => docs}/src/dtkcore.qdoc | 0 9 files changed, 19 insertions(+), 10 deletions(-) create mode 100644 debian/libdtkcore-doc.install rename {doc => docs}/CMakeLists.txt (76%) rename {doc => docs}/Specification.md (100%) rename {doc => docs}/src/dtkcore-index.qdoc (100%) rename {doc => docs}/src/dtkcore.qdoc (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 33a2476c..e8420fbd 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -41,7 +41,7 @@ else () endif () if (BUILD_DOCS) - add_subdirectory(doc) + add_subdirectory(docs) endif () add_subdirectory(src) diff --git a/archlinux/PKGBUILD b/archlinux/PKGBUILD index 0aafc6ba..76839e25 100644 --- a/archlinux/PKGBUILD +++ b/archlinux/PKGBUILD @@ -19,7 +19,8 @@ build() { cmake -GNinja \ -DNOTPACKAGE=OFF \ -DLINUXNAME="archlinux"\ - -DBUILD_DOCS=OFF \ + -DBUILD_DOCS=ON \ + -DQCH_INSTALL_DESTINATION=/usr/share/doc/qt \ -DCMAKE_INSTALL_LIBDIR=/usr/lib \ -DCMAKE_INSTALL_PREFIX=/usr \ -DCMAKE_BUILD_TYPE=Release diff --git a/debian/control b/debian/control index 12f250ca..c4727bd2 100644 --- a/debian/control +++ b/debian/control @@ -3,7 +3,7 @@ Section: libdevel Priority: optional Maintainer: Deepin Packages Builder Build-Depends: debhelper (>= 9), pkg-config, - qttools5-dev-tools, qtbase5-private-dev, + qttools5-dev-tools, qtbase5-private-dev, doxygen, libgsettings-qt-dev, libgtest-dev, libdtkcommon-dev, cmake Standards-Version: 3.9.8 @@ -32,3 +32,11 @@ Description: Deepin Tool Kit Core Devel library DtkCore is base devel library of Deepin Qt/C++ applications. . This package contains the header files and static libraries of DtkCore + +Package: libdtkcore-doc +Architecture: any +Description: Deepin Tool Kit Core (document) + DtkCore is base devel library of Deepin Qt/C++ applications. + . + This package contains the doc files of DtkCore + diff --git a/debian/libdtkcore-doc.install b/debian/libdtkcore-doc.install new file mode 100644 index 00000000..06733f05 --- /dev/null +++ b/debian/libdtkcore-doc.install @@ -0,0 +1 @@ +usr/share/qt5/doc/dtkcore.qch diff --git a/debian/rules b/debian/rules index ab25aa23..f30f0330 100755 --- a/debian/rules +++ b/debian/rules @@ -15,7 +15,7 @@ BUILD_VER = $(shell echo $(VERSION) | awk -F'[+_~-]' '{print $$2}' | sed 's/[^0- dh $@ --parallel override_dh_auto_configure: - dh_auto_configure -- -DNOTPACKAGE=OFF -DBUILD_DOCS=OFF -DBUILD_VERSION=$(BUILD_VER) -DDVERSION=$(PACK_VER) + dh_auto_configure -- -DNOTPACKAGE=OFF -DBUILD_DOCS=ON -DBUILD_VERSION=$(BUILD_VER) -DDVERSION=$(PACK_VER) #override_dh_auto_test: # echo "skip auto test" diff --git a/doc/CMakeLists.txt b/docs/CMakeLists.txt similarity index 76% rename from doc/CMakeLists.txt rename to docs/CMakeLists.txt index 6251fb3d..55e8fd45 100644 --- a/doc/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -2,16 +2,15 @@ cmake_minimum_required (VERSION 3.10) find_package (Doxygen REQUIRED) -set (QCH_INSTALL_DESTINATION ${CMAKE_INSTALLL_PREFIX}/share/DDE/dtk CACHE STRING "QCH install location") +set (QCH_INSTALL_DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/qt5/doc CACHE STRING "QCH install location") -set (DOXYGEN_GENERATE_HTML "NO" CACHE STRING "Doxygen HTML output") -set (DOXYGEN_GENERATE_XML "NO" CACHE STRING "Doxygen XML output") -set (DOXYGEN_GENERATE_QHP "YES" CACHE STRING "Doxygen QHP output") +set (DOXYGEN_GENERATE_HTML YES CACHE STRING "Doxygen HTML output") +set (DOXYGEN_GENERATE_XML YES CACHE STRING "Doxygen XML output") +set (DOXYGEN_GENERATE_QHP YES CACHE STRING "Doxygen QHP output") set (DOXYGEN_FILE_PATTERNS *.cpp *.h *.zh_CN.md *.zh_CN.dox CACHE STRING "Doxygen File Patterns") set (DOXYGEN_PROJECT_NUMBER ${CMAKE_PROJECT_VERSION} CACHE STRING "") # Should be the same as this project is using. set (DOXYGEN_EXTRACT_STATIC YES) set (DOXYGEN_OUTPUT_LANGUAGE "Chinese") -set (DOXYGEN_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/docs/) set (DOXYGEN_QHG_LOCATION "qhelpgenerator") set (DOXYGEN_QHP_NAMESPACE "org.deepin.dtk.core") set (DOXYGEN_QCH_FILE "dtkcore.qch") @@ -30,7 +29,7 @@ set (DOXYGEN_EXPAND_ONLY_PREDEF "YES") doxygen_add_docs (doxygen ${PROJECT_SOURCE_DIR}/src ${PROJECT_SOURCE_DIR}/include - ${PROJECT_SOURCE_DIR}/doc + ${PROJECT_SOURCE_DIR}/docs ALL WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} COMMENT "Generate documentation via Doxygen" diff --git a/doc/Specification.md b/docs/Specification.md similarity index 100% rename from doc/Specification.md rename to docs/Specification.md diff --git a/doc/src/dtkcore-index.qdoc b/docs/src/dtkcore-index.qdoc similarity index 100% rename from doc/src/dtkcore-index.qdoc rename to docs/src/dtkcore-index.qdoc diff --git a/doc/src/dtkcore.qdoc b/docs/src/dtkcore.qdoc similarity index 100% rename from doc/src/dtkcore.qdoc rename to docs/src/dtkcore.qdoc