[ksokoban/port-to-kf5] /: Re-enable the documentation (optional)

Luigi Toscano null at kde.org
Sun Aug 27 12:44:59 UTC 2017


Git commit 518098aa1827eadb753b2d4177720111c5efec3a by Luigi Toscano.
Committed on 27/08/2017 at 12:44.
Pushed by ltoscano into branch 'port-to-kf5'.

Re-enable the documentation (optional)

- look for KF5::DocTools and include the doc/ directory if found;
- port to the KF5 macro including the used variables and parameters;
- port to the native KF5 DTD and remove few obsolete entities;
- remove the deprecated "installation" section from the documentation.

M  +5    -0    CMakeLists.txt
M  +1    -1    doc/CMakeLists.txt
M  +1    -12   doc/index.docbook

https://commits.kde.org/ksokoban/518098aa1827eadb753b2d4177720111c5efec3a

diff --git a/CMakeLists.txt b/CMakeLists.txt
index fc6e242..98b42e4 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -31,6 +31,8 @@ find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS
     XmlGui
 )
 
+find_package(KF5 ${KF5_MIN_VERSION} COMPONENTS DocTools)
+
 feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES)
 
 set(ksokoban_SRCS
@@ -66,5 +68,8 @@ target_link_libraries(ksokoban
 )
 
 add_subdirectory(data)
+if(KF5DocTools_FOUND)
+    add_subdirectory(doc)
+endif()
 
 install(TARGETS ksokoban ${INSTALL_TARGETS_DEFAULT_ARGS})
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 0df9c9a..5e799ef 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -1,4 +1,4 @@
 ########### install files ###############
 #
 #
-kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en)
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR ksokoban)
diff --git a/doc/index.docbook b/doc/index.docbook
index 93fbfbe..0b2b022 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -1,7 +1,5 @@
 <?xml version="1.0" ?>
-<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
-  <!ENTITY kappname "&ksokoban;">
-  <!ENTITY package "kdegames">
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
   <!ENTITY % English "INCLUDE" > <!-- change language only here -->
   <!ENTITY % addindex "IGNORE">
 ]>
@@ -415,15 +413,6 @@ http://users.bentonrea.com/~sasquatch/sokoban/</ulink>
 &underGPL;
 </chapter>
 
-<appendix id="installation">
-<title>Installation</title>
-
-&install.intro.documentation;
-
-&install.compile.documentation;
-
-</appendix>
-
 &documentation.index; 
 </book>
 


More information about the kde-doc-english mailing list