Merge branch 'kdchart-3.0'

.github/workflows/documentation.yml

@@ -0,0 +1,69 @@
+# SPDX-FileCopyrightText: 2024 Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>
+#
+# SPDX-License-Identifier: MIT
+
+name: Deploy doxygen to GitHub Pages
+
+on:
+  push:
+    branches:
+      - kdchart-3.0
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install Dependencies on Linux
+        run: |
+          sudo apt update -qq
+          sudo apt install -y doxygen
+
+      - name: Install Qt
+        uses: jurplel/install-qt-action@v3
+        with:
+          aqtversion: null # use whatever the default is
+          version: 5.15.2
+          cache: true
+
+      - name: Checkout sources
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Configure project
+        run: >
+          cmake -S . -B ./build -DKDChart_DOCS=ON
+
+      - name: Create docs
+        run: cmake --build ./build --target docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build/docs/api/html/
+
+  # Deployment job, what was uploaded to artifact
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.pre-commit-config.yaml

@@ -6,7 +6,7 @@ ci:
 exclude: ^(cmake/ECM/|cmake/KDAB/|docs/api/doxygen-awesome.css)
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.6.0
+  rev: v5.0.0
   hooks:
   - id: trailing-whitespace
   - id: end-of-file-fixer
@@ -19,11 +19,11 @@ repos:
   - id: destroyed-symlinks
   - id: check-executables-have-shebangs
 - repo: https://github.com/pre-commit/mirrors-clang-format
-  rev: v18.1.8
+  rev: v19.1.3
   hooks:
   - id: clang-format
 - repo: https://github.com/PyCQA/pylint
-  rev: v3.2.4
+  rev: v3.3.1
   hooks:
   - id: pylint
     exclude: ^(.cmake-format.py|conan/conanfile.py|scripts/genignore.py)
@@ -51,6 +51,6 @@ repos:
     language: ruby
     files: \.(md|mdown|markdown)$
 - repo: https://github.com/fsfe/reuse-tool
-  rev: v3.1.0a1
+  rev: v4.0.3
   hooks:
   - id: reuse

README.md

@@ -28,7 +28,7 @@ See [INSTALL.txt](INSTALL.txt) for installation instructions using CMake.
 After reading the introductory overview files in docs/
 you will find more information at these places:
 
-* [detailed browsable API reference](https://docs.kdab.com/kdchart)
+* [detailed browsable API reference](https://kdab.github.io/KDChart)
 * [programmers manual with examples](docs/manual/kdchart.pdf)
 * [our sorted example programs](examples/)
 

REUSE.toml

@@ -0,0 +1,46 @@
+version = 1
+SPDX-PackageName = "KDChart"
+SPDX-PackageSupplier = "<[email protected]>"
+SPDX-PackageDownloadLocation = "https://www.github.com/KDAB/KDChart"
+
+#misc source code
+[[annotations]]
+path = ["**.qrc", "**.ui", "**.xml", "**.kdx", "**.kxs", "**.conf", "**.csv", "**.cht", "**.map", "**.bat"]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>"
+SPDX-License-Identifier = "MIT"
+
+#artwork
+[[annotations]]
+path = ["images/**.png", "docs/api/**.png", "examples/**/**.png", "images/**.svg", "src/KDChart/resources/**.svg"]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>"
+SPDX-License-Identifier = "MIT"
+
+#misc documentation
+[[annotations]]
+path = ["**md", "**.txt", "CHANGES", "src/TODO", "**.html", "docs/manual/**.pdf"]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>"
+SPDX-License-Identifier = "MIT"
+
+#misc config files
+[[annotations]]
+path = [".pre-commit-config.yaml", ".codespellrc", ".krazy", ".cmake-format.py", ".clang-format", ".clazy", ".gitignore", ".mdlrc", ".mdlrc.rb", ".pep8", ".pylintrc", "docs/api/Doxyfile.cmake", "distro/**", "REUSE.toml"]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "Klarälvdalens Datakonsult AB, a KDAB Group company <[email protected]>"
+SPDX-License-Identifier = "BSD-3-Clause"
+
+#3rdparty
+[[annotations]]
+path = "cmake/ECM/modules/**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "The KDE Project"
+SPDX-License-Identifier = "BSD-3-Clause"
+
+# doxygen awesome
+[[annotations]]
+path = "docs/api/doxygen-awesome.css"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2021 - 2023 jothepro"
+SPDX-License-Identifier = "MIT"

cmake/ECM/modules/ECMQueryQt.cmake

@@ -47,23 +47,21 @@ endif()
 if (QT_MAJOR_VERSION STREQUAL "5")
     # QUIET to accommodate the TRY option
     find_package(Qt${QT_MAJOR_VERSION}Core QUIET)
+    set(_exec_name_text "Qt5 qmake")
     if(TARGET Qt5::qmake)
         get_target_property(_qmake_executable_default Qt5::qmake LOCATION)
 
-        set(QUERY_EXECUTABLE ${_qmake_executable_default}
-            CACHE FILEPATH "Location of the Qt5 qmake executable")
-        set(_exec_name_text "Qt5 qmake")
+        set(QUERY_EXECUTABLE ${_qmake_executable_default})
         set(_cli_option "-query")
     endif()
 elseif(QT_MAJOR_VERSION STREQUAL "6")
     # QUIET to accommodate the TRY option
     find_package(Qt6 COMPONENTS CoreTools QUIET CONFIG)
+    set(_exec_name_text "Qt6 qtpaths")
     if (TARGET Qt6::qtpaths)
         get_target_property(_qtpaths_executable Qt6::qtpaths LOCATION)
 
-        set(QUERY_EXECUTABLE ${_qtpaths_executable}
-            CACHE FILEPATH "Location of the Qt6 qtpaths executable")
-        set(_exec_name_text "Qt6 qtpaths")
+        set(QUERY_EXECUTABLE ${_qtpaths_executable})
         set(_cli_option "--query")
     endif()
 endif()

cmake/KDAB/modules/FindPySide6.cmake

@@ -86,8 +86,7 @@ if(PYSIDE6_FOUND)
     #PySide
     #===============================================================================
     find_path(
-        PYSIDE_INCLUDE_DIR
-        pyside.h
+        PYSIDE_INCLUDE_DIR pyside.h
         PATH_SUFFIXES PySide6
         PATHS ${PYSIDE6_BASEDIR}/include ${PYSIDE_CUSTOM_PREFIX}/include
     )
@@ -110,9 +109,9 @@ if(PYSIDE6_FOUND)
     )
 
     find_path(
-        PYSIDE_TYPESYSTEMS
-        typesystem_core.xml
-        PATHS ${PYSIDE6_BASEDIR}/typesystems ${PYSIDE_CUSTOM_PREFIX}/share/PySide6/typesystems /usr/share/PySide6/typesystems
+        PYSIDE_TYPESYSTEMS typesystem_core.xml
+        PATHS ${PYSIDE6_BASEDIR}/typesystems ${PYSIDE_CUSTOM_PREFIX}/share/PySide6/typesystems
+              /usr/share/PySide6/typesystems
         NO_DEFAULT_PATH
     )
 endif()

cmake/KDAB/modules/FindShiboken6.cmake

@@ -111,10 +111,7 @@ if(SHIBOKEN_BASEDIR)
         PATHS ${SHIBOKEN_SEARCH_PATHS}
     )
 
-    find_program(
-        SHIBOKEN_BINARY shiboken6
-        PATHS ${SHIBOKEN_SEARCH_PATHS}
-    )
+    find_program(SHIBOKEN_BINARY shiboken6 PATHS ${SHIBOKEN_SEARCH_PATHS})
 endif()
 if(SHIBOKEN_INCLUDE_DIR
    AND SHIBOKEN_LIBRARY

cmake/KDAB/modules/KDPySide2ModuleBuild.cmake

@@ -18,7 +18,6 @@ endif()
 
 message(STATUS "PYTHON INSTALL PREFIX ${${PROJECT_NAME}_PYTHON_BINDINGS_INSTALL_PREFIX}")
 
-
 if(WIN32)
     set(PATH_SEP "\;")
 else()

cmake/KDAB/modules/KDQtInstallPaths.cmake

@@ -49,7 +49,10 @@ foreach(qval ${VARS_LIST})
             list(GET QVAL_LIST 1 path)
         endif()
         if(NOT ${var}) #if set already on the command line for example
-            set(${var} ${path} CACHE PATH "Qt install path for ${var}")
+            set(${var}
+                ${path}
+                CACHE PATH "Qt install path for ${var}"
+            )
         endif()
     endif()
 endforeach()