Git commit 762c71143fb5104464126c00f24116e46a7ecd10 by Laurent Montel. Committed on 08/08/2025 at 05:45. Pushed by mlaurent into branch 'master'.
Initial doc support M +1 -0 .kde-ci.yml M +14 -0 CMakeLists.txt A +3 -0 doc/CMakeLists.txt A +96 -0 doc/index.docbook https://invent.kde.org/utilities/kaichat/-/commit/762c71143fb5104464126c00f24116e46a7ecd10 diff --git a/.kde-ci.yml b/.kde-ci.yml index 004b34a..9e9f207 100644 --- a/.kde-ci.yml +++ b/.kde-ci.yml @@ -15,6 +15,7 @@ Dependencies: 'frameworks/kiconthemes': '@latest-kf6' 'frameworks/kcrash': '@latest-kf6' 'libraries/ktextaddons': '@latest-kf6' + 'frameworks/kdoctools': '@latest-kf6' 'frameworks/kio': '@latest-kf6' 'frameworks/kstatusnotifieritem': '@latest-kf6' diff --git a/CMakeLists.txt b/CMakeLists.txt index 9a6e194..b0685ce 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -60,6 +60,16 @@ include(GenerateExportHeader) include(ECMDeprecationSettings) include(ECMCheckOutboundLicense) +find_package(KF6DocTools ${KF_MIN_VERSION}) +set_package_properties( + KF6DocTools + PROPERTIES + DESCRIPTION + "Tools to generate documentation" + TYPE + OPTIONAL +) + set(KTEXTADDONS_WITH_TEXTAUTOGENERATETEXT_VERSION "1.7.48") find_package(Qt6 ${QT_REQUIRED_VERSION} REQUIRED NO_MODULE COMPONENTS Widgets) @@ -131,6 +141,10 @@ configure_file(config-kaichat.h.in ${CMAKE_CURRENT_BINARY_DIR}/config-kaichat.h) add_subdirectory(src) ki18n_install(po) +if(KF6DocTools_FOUND) + kdoctools_install(po) + add_subdirectory(doc) +endif() file( GLOB_RECURSE ALL_SOURCE_FILES src/apps/*.h diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000..2d2b0ad --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2025 Laurent Montel <[email protected]> +# SPDX-License-Identifier: BSD-3-Clause +kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kaichat) diff --git a/doc/index.docbook b/doc/index.docbook new file mode 100644 index 0000000..be11b77 --- /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>KAIChat</application>"> + <!ENTITY kappname "&i18n-kapplication;"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book id="kaichat" lang="&language;"> + +<bookinfo id="kaichatinfo"> + +<title>The &i18n-kapplication; Handbook</title> + +<authorgroup> +<author> +<personname> +<firstname>Laurent</firstname> +<surname>Montel</surname> +</personname> +<email>[email protected]</email> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2025</year> +<holder>Laurent Montel</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2025-08-08</date> +<releaseinfo></releaseinfo> + +<abstract> +<para> +&i18n-kapplication; is an AI chat. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>AI</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> +<para>&i18n-kapplication; is a chat application for accessing to Ollama or network AI service.</para> + +<sect1 id="using-kapp"> +<title>Using &i18n-kapplication;</title> + +<para>&i18n-kapplication; allows to connect to Ollama local server or network AI service.</para> + +</sect1> + +</chapter> + +<chapter id="credits"> + +<title>Credits and License</title> + +<para>&i18n-kapplication;</para> +<para> +Program copyright 2025 &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; +-->
