[graphics/drawy] /: Add kde doc support (basic for the moment we need to write doc in index.docbook)
Laurent Montel
null at kde.org
Mon Feb 23 06:39:43 GMT 2026
Git commit da00336a5ce5583ab209e63828480078be18cb5e by Laurent Montel.
Committed on 23/02/2026 at 06:29.
Pushed by mlaurent into branch 'master'.
Add kde doc support (basic for the moment we need to write doc in index.docbook)
M +1 -0 .kde-ci.yml
M +15 -0 CMakeLists.txt
A +3 -0 doc/CMakeLists.txt
A +96 -0 doc/index.docbook
https://invent.kde.org/graphics/drawy/-/commit/da00336a5ce5583ab209e63828480078be18cb5e
diff --git a/.kde-ci.yml b/.kde-ci.yml
index 7684bac8..78285dfa 100644
--- a/.kde-ci.yml
+++ b/.kde-ci.yml
@@ -14,6 +14,7 @@ Dependencies:
'frameworks/kiconthemes': '@latest-kf6'
'frameworks/ki18n': '@latest-kf6'
'frameworks/syntax-highlighting': '@latest-kf6'
+ 'frameworks/kdoctools': '@latest-kf6'
Options:
require-passing-tests-on: ['Linux']
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 9b747807..09cf0efd 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -60,6 +60,17 @@ find_package(
I18n
SyntaxHighlighting
)
+
+find_package(KF6DocTools ${KF_MIN_VERSION})
+set_package_properties(
+ KF6DocTools
+ PROPERTIES
+ DESCRIPTION
+ "Tools to generate documentation"
+ TYPE
+ OPTIONAL
+)
+
option(USE_UNITY_CMAKE_SUPPORT "Use UNITY cmake support (speedup compile time)" OFF)
option(ENABLE_PCH "Enable Precompiled Headers support" ON)
@@ -170,4 +181,8 @@ ecm_qt_install_logging_categories(
update_xdg_mimetypes(${KDE_INSTALL_MIMEDIR})
ki18n_install(po)
+if(KF6DocTools_FOUND)
+ kdoctools_install(po)
+ add_subdirectory(doc)
+endif()
feature_summary(WHAT ALL FATAL_ON_MISSING_REQUIRED_PACKAGES)
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 00000000..ec984b83
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2026 Laurent Montel <montel at kde.org>
+# SPDX-License-Identifier: BSD-3-Clause
+kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR drawy)
diff --git a/doc/index.docbook b/doc/index.docbook
new file mode 100644
index 00000000..352823c8
--- /dev/null
+++ b/doc/index.docbook
@@ -0,0 +1,96 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
+"dtd/kdedbx45.dtd" [
+ <!-- Define an entity for your application if it is not part of KDE
+ CVS -->
+ <!ENTITY i18n-kapplication "<application>Drawy</application>">
+ <!ENTITY kappname "&i18n-kapplication;">
+ <!ENTITY % addindex "IGNORE">
+ <!ENTITY % English "INCLUDE">
+]>
+
+<book id="drawy" lang="&language;">
+
+<bookinfo id="drawyinfo">
+
+<title>The &i18n-kapplication; Handbook</title>
+
+<authorgroup>
+<author>
+<personname>
+<firstname>Laurent</firstname>
+<surname>Montel</surname>
+</personname>
+<email>montel at kde.org</email>
+</author>
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</authorgroup>
+
+<copyright>
+<year>2026</year>
+<holder>Laurent Montel</holder>
+</copyright>
+
+<legalnotice>&FDLNotice;</legalnotice>
+
+<date>2026-02-23</date>
+<releaseinfo></releaseinfo>
+
+<abstract>
+<para>
+&i18n-kapplication; is a work-in-progress infinite whiteboard tool.
+</para>
+</abstract>
+
+<keywordset>
+<keyword>KDE</keyword>
+<keyword>whiteboard</keyword>
+</keywordset>
+</bookinfo>
+
+<chapter id="introduction">
+<title>Introduction</title>
+<para>&i18n-kapplication; is a work-in-progress infinite whiteboard tool written in Qt/C++.</para>
+
+<sect1 id="using-kapp">
+<title>Using &i18n-kapplication;</title>
+
+<para>&i18n-kapplication; is a work-in-progress infinite whiteboard tool written in Qt/C++, which aims to be a native-desktop alternative to the amazing web-based Excalidraw.</para>
+
+</sect1>
+
+</chapter>
+
+<chapter id="credits">
+
+<title>Credits and License</title>
+
+<para>&i18n-kapplication;</para>
+<para>
+Program copyright 2026 &Laurent.Montel; &Laurent.Montel.mail;
+</para>
+<para>
+Documentation Copyright © &Laurent.Montel; &Laurent.Montel.mail;
+</para>
+
+<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
+
+&underFDL; <!-- FDL: do not remove -->
+&underGPL; <!-- GPL License -->
+</chapter>
+
+&documentation.index;
+</book>
+
+<!--
+Local Variables:
+mode: xml
+sgml-minimize-attributes:nil
+sgml-general-insert-case:lower
+sgml-indent-step:0
+sgml-indent-data:nil
+End:
+
+vim:tabstop=2:shiftwidth=2:expandtab
+kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
+-->
More information about the kde-doc-english
mailing list