From ce39eeac915b697339ab40b4bbeb17218bda2daf Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 18:16:40 -0400 Subject: [PATCH 01/21] docs: migrate documentation to Dockle --- .gitignore | 5 +++-- .gitmodules | 8 ++++---- .readthedocs.yaml | 25 ++++++++----------------- CMakeLists.txt | 3 ++- dockle.toml | 24 ++++++++++++++++++++++++ docs/Doxyfile | 41 ----------------------------------------- third-party/dockle | 1 + third-party/doxyconfig | 1 - 8 files changed, 42 insertions(+), 66 deletions(-) create mode 100644 dockle.toml delete mode 100644 docs/Doxyfile create mode 160000 third-party/dockle delete mode 160000 third-party/doxyconfig diff --git a/.gitignore b/.gitignore index 4a2c739c..030b74db 100644 --- a/.gitignore +++ b/.gitignore @@ -44,5 +44,6 @@ build/ cmake-*/ -# doxyconfig -docs/doxyconfig* +# Dockle +/.dockle/ +/_site/ diff --git a/.gitmodules b/.gitmodules index 67e53761..f9a536b4 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,8 +1,8 @@ -[submodule "third-party/doxyconfig"] - path = third-party/doxyconfig - url = https://github.com/LizardByte/doxyconfig.git - branch = master [submodule "third-party/lizardbyte-common"] path = third-party/lizardbyte-common url = https://github.com/LizardByte/lizardbyte-common.git branch = master +[submodule "third-party/dockle"] + path = third-party/dockle + url = https://github.com/LizardByte/dockle.git + branch = master diff --git a/.readthedocs.yaml b/.readthedocs.yaml index ee2f3bb2..08cbc2e5 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,29 +1,20 @@ --- -# .readthedocs.yaml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - version: 2 build: os: ubuntu-24.04 tools: - python: "miniconda-latest" + python: "miniforge3-26.3" commands: - - | - if [ -f readthedocs_build.sh ]; then - doxyconfig_dir="." - else - doxyconfig_dir="./third-party/doxyconfig" - fi - chmod +x "${doxyconfig_dir}/readthedocs_build.sh" - export DOXYCONFIG_DIR="${doxyconfig_dir}" - "${doxyconfig_dir}/readthedocs_build.sh" + - conda env create --quiet --name "${READTHEDOCS_VERSION}" --file third-party/dockle/environment.yml + - conda run --no-capture-output --name "${READTHEDOCS_VERSION}" python -m pip install 'lizardbyte-dockle[all] @ https://github.com/LizardByte/dockle/releases/download/v2026.918.203650/lizardbyte_dockle-2026.918.203650-py3-none-any.whl' + - conda run --no-capture-output --name "${READTHEDOCS_VERSION}" env PYTHONPATH=third-party/dockle/src python -m dockle check + - conda run --no-capture-output --name "${READTHEDOCS_VERSION}" env PYTHONPATH=third-party/dockle/src python -m dockle build + - mkdir -p "${READTHEDOCS_OUTPUT}html/" + - cp -r _site/. "${READTHEDOCS_OUTPUT}html/" -# using conda, we can get newer doxygen and graphviz than ubuntu provide -# https://github.com/readthedocs/readthedocs.org/issues/8151#issuecomment-890359661 conda: - environment: third-party/doxyconfig/environment.yml + environment: third-party/dockle/environment.yml submodules: include: all diff --git a/CMakeLists.txt b/CMakeLists.txt index 88cf108e..793a44c5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -142,7 +142,8 @@ target_link_libraries(${PROJECT_NAME} PRIVATE ${TRAY_EXTERNAL_LIBRARIES}) # if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) if(BUILD_DOCS) - add_subdirectory(third-party/doxyconfig docs) + include(third-party/dockle/cmake/Dockle.cmake) + dockle_add_docs(docs TARGETS api) endif() if(BUILD_TESTS) diff --git a/dockle.toml b/dockle.toml new file mode 100644 index 00000000..9c27ea73 --- /dev/null +++ b/dockle.toml @@ -0,0 +1,24 @@ +[project] +name = "tray" +version = "0.0.0" +description = "Cross-platform implementation of a system tray icon with a popup menu and notifications." +repository = "https://github.com/LizardByte/tray" +logo = "tray.svg" +favicon = "tray.svg" + +[build] +output = "_site" +work = ".dockle" +strict = true +clean = true + +[[targets]] +name = "api" +title = "tray documentation" +framework = "doxygen" +source = "." + +[targets.doxygen] +inputs = ["README.md", "src"] +image_paths = ["docs/images"] +main_page = "README.md" diff --git a/docs/Doxyfile b/docs/Doxyfile deleted file mode 100644 index a4c89eee..00000000 --- a/docs/Doxyfile +++ /dev/null @@ -1,41 +0,0 @@ -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). -# -# Note: -# -# Use doxygen to compare the used configuration file with the template -# configuration file: -# doxygen -x [configFile] -# Use doxygen to compare the used configuration file with the template -# configuration file without replacing the environment variables or CMake type -# replacement variables: -# doxygen -x_noenv [configFile] - -# project metadata -DOCSET_BUNDLE_ID = dev.lizardbyte.tray -DOCSET_PUBLISHER_ID = dev.lizardbyte.tray.documentation -PROJECT_BRIEF = "Cross-platform implementation of a system tray icon with a popup menu and notifications." -PROJECT_ICON = ../tray.svg -PROJECT_LOGO = ../tray.svg -PROJECT_NAME = tray - -# project specific settings -DOT_GRAPH_MAX_NODES = 50 -IMAGE_PATH = ../docs/images -INCLUDE_PATH = - -# files and directories to process -USE_MDFILE_AS_MAINPAGE = ../README.md -INPUT = ../README.md \ - ../third-party/doxyconfig/docs/source_code.md \ - ../src diff --git a/third-party/dockle b/third-party/dockle new file mode 160000 index 00000000..db7e8d89 --- /dev/null +++ b/third-party/dockle @@ -0,0 +1 @@ +Subproject commit db7e8d8971382e115e999fc87218c6248a18e2be diff --git a/third-party/doxyconfig b/third-party/doxyconfig deleted file mode 160000 index 419127ba..00000000 --- a/third-party/doxyconfig +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 419127bad87f49b2d45fa957ea7302abbb49c01f From 1864c8f0f5baaf44e4a3630a8e20527c4e74f28b Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 19:29:00 -0400 Subject: [PATCH 02/21] fix: refine Dockle migration --- .gitmodules | 8 ++++---- .readthedocs.yaml | 21 ++++++++++++++------- third-party/dockle | 2 +- 3 files changed, 19 insertions(+), 12 deletions(-) diff --git a/.gitmodules b/.gitmodules index f9a536b4..65b8df97 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,8 +1,8 @@ -[submodule "third-party/lizardbyte-common"] - path = third-party/lizardbyte-common - url = https://github.com/LizardByte/lizardbyte-common.git - branch = master [submodule "third-party/dockle"] path = third-party/dockle url = https://github.com/LizardByte/dockle.git branch = master +[submodule "third-party/lizardbyte-common"] + path = third-party/lizardbyte-common + url = https://github.com/LizardByte/lizardbyte-common.git + branch = master diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 08cbc2e5..af1bea96 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,17 +1,24 @@ --- +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + version: 2 build: os: ubuntu-24.04 tools: - python: "miniforge3-26.3" + python: "miniconda-latest" commands: - - conda env create --quiet --name "${READTHEDOCS_VERSION}" --file third-party/dockle/environment.yml - - conda run --no-capture-output --name "${READTHEDOCS_VERSION}" python -m pip install 'lizardbyte-dockle[all] @ https://github.com/LizardByte/dockle/releases/download/v2026.918.203650/lizardbyte_dockle-2026.918.203650-py3-none-any.whl' - - conda run --no-capture-output --name "${READTHEDOCS_VERSION}" env PYTHONPATH=third-party/dockle/src python -m dockle check - - conda run --no-capture-output --name "${READTHEDOCS_VERSION}" env PYTHONPATH=third-party/dockle/src python -m dockle build - - mkdir -p "${READTHEDOCS_OUTPUT}html/" - - cp -r _site/. "${READTHEDOCS_OUTPUT}html/" + - | + if [ -f readthedocs_build.sh ]; then + dockle_dir="." + else + dockle_dir="./third-party/dockle" + fi + chmod +x "${dockle_dir}/readthedocs_build.sh" + export DOCKLE_DIR="${dockle_dir}" + "${dockle_dir}/readthedocs_build.sh" conda: environment: third-party/dockle/environment.yml diff --git a/third-party/dockle b/third-party/dockle index db7e8d89..7a365d30 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit db7e8d8971382e115e999fc87218c6248a18e2be +Subproject commit 7a365d303e44167f78d2d3920aff74b259be2164 From 0cb104a7a698c79ff8a29e4e4dc3005d27c36df1 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 19:31:47 -0400 Subject: [PATCH 03/21] chore: update Dockle pin --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 7a365d30..e4a8e2d7 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 7a365d303e44167f78d2d3920aff74b259be2164 +Subproject commit e4a8e2d7fb879485db839ffb18ece671ad0bccbf From 7025b910170f83df514df3990aa019e12e110a24 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 19:41:31 -0400 Subject: [PATCH 04/21] chore: update Dockle pin --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index e4a8e2d7..99cff207 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit e4a8e2d7fb879485db839ffb18ece671ad0bccbf +Subproject commit 99cff207f621f1f09d85bd79f58d0c60b98e94e1 From b49746e8408ff848eabe0565b614694c9eca1ae9 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 20:00:07 -0400 Subject: [PATCH 05/21] fix: preserve Read the Docs setup --- .readthedocs.yaml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index af1bea96..784b56b8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,16 +9,18 @@ build: os: ubuntu-24.04 tools: python: "miniconda-latest" - commands: - - | - if [ -f readthedocs_build.sh ]; then - dockle_dir="." - else - dockle_dir="./third-party/dockle" - fi - chmod +x "${dockle_dir}/readthedocs_build.sh" - export DOCKLE_DIR="${dockle_dir}" - "${dockle_dir}/readthedocs_build.sh" + jobs: + build: + html: + - | + if [ -f readthedocs_build.sh ]; then + dockle_dir="." + else + dockle_dir="./third-party/dockle" + fi + chmod +x "${dockle_dir}/readthedocs_build.sh" + export DOCKLE_DIR="${dockle_dir}" + "${dockle_dir}/readthedocs_build.sh" conda: environment: third-party/dockle/environment.yml From 3d53b48d1a3e43332caff9d36cc21f6beb52367c Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 20:50:14 -0400 Subject: [PATCH 06/21] fix: refine Dockle documentation --- README.md | 101 ++++++++++++++++++--------------------------- dockle.toml | 1 + third-party/dockle | 2 +- 3 files changed, 43 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index d5b2a826..26ec98dd 100644 --- a/README.md +++ b/README.md @@ -36,27 +36,19 @@ This fork adds the following features: ## 🖼️ Screenshots -
- -
+} +} ## 🖥️ Supported platforms @@ -75,50 +67,39 @@ This fork adds the following features: Install either Qt6 _or_ Qt5. -
- -- Arch - ```bash - # Qt6 - sudo pacman -S qt6-base qt6-svg - - # Qt5 - sudo pacman -S qt5-base qt5-svg - ``` - -- Debian/Ubuntu - ```bash - # Qt6 - sudo apt install qt6-base-dev qt6-svg-dev - - # Qt5 - sudo apt install qtbase5-dev libqt5svg5-dev - ``` - -- Fedora - ```bash - # Qt6 - sudo dnf install qt6-qtbase-devel qt6-qtsvg-devel - - # Qt5 - sudo dnf install qt5-qtbase-devel qt5-qtsvg-devel - ``` - -- macOS - ```bash - brew install cmake ninja qtbase qtsvg - ``` - -- Windows (MSYS2 UCRT64) - ```bash - pacman -S mingw-w64-ucrt-x86_64-cmake \ - mingw-w64-ucrt-x86_64-ninja \ - mingw-w64-ucrt-x86_64-toolchain \ - mingw-w64-ucrt-x86_64-qt6-base \ - mingw-w64-ucrt-x86_64-qt6-svg - ``` - -
+@tabs{ +@tab{Arch|:|```bash +# Qt6 +sudo pacman -S qt6-base qt6-svg + +# Qt5 +sudo pacman -S qt5-base qt5-svg +```} +@tab{Debian/Ubuntu|:|```bash +# Qt6 +sudo apt install qt6-base-dev qt6-svg-dev + +# Qt5 +sudo apt install qtbase5-dev libqt5svg5-dev +```} +@tab{Fedora|:|```bash +# Qt6 +sudo dnf install qt6-qtbase-devel qt6-qtsvg-devel + +# Qt5 +sudo dnf install qt5-qtbase-devel qt5-qtsvg-devel +```} +@tab{macOS|:|```bash +brew install cmake ninja qtbase qtsvg +```} +@tab{Windows (MSYS2 UCRT64)|:|```bash +pacman -S mingw-w64-ucrt-x86_64-cmake \ + mingw-w64-ucrt-x86_64-ninja \ + mingw-w64-ucrt-x86_64-toolchain \ + mingw-w64-ucrt-x86_64-qt6-base \ + mingw-w64-ucrt-x86_64-qt6-svg +```} +} ## 🛠️ Building diff --git a/dockle.toml b/dockle.toml index 9c27ea73..911e4ccd 100644 --- a/dockle.toml +++ b/dockle.toml @@ -17,6 +17,7 @@ name = "api" title = "tray documentation" framework = "doxygen" source = "." +home = true [targets.doxygen] inputs = ["README.md", "src"] diff --git a/third-party/dockle b/third-party/dockle index 99cff207..05194bf1 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 99cff207f621f1f09d85bd79f58d0c60b98e94e1 +Subproject commit 05194bf1b383303b2e49068c46ed8f3b272593de From b82af6cf1dea49017c968ed68fe96fb0d2842919 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 20:53:44 -0400 Subject: [PATCH 07/21] chore: update Dockle --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 05194bf1..12f213bb 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 05194bf1b383303b2e49068c46ed8f3b272593de +Subproject commit 12f213bb52b62452f18a92790201602dc61bab19 From b4039bb098514ca9a8e4ab47f2113316061b9968 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 21:01:04 -0400 Subject: [PATCH 08/21] build: update Dockle preview --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 12f213bb..8435e3a7 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 12f213bb52b62452f18a92790201602dc61bab19 +Subproject commit 8435e3a7ada906521fd66513ee05ac224e71c9a5 From dc8a05c85943979350bf70f437f3865a6d43e89c Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 21:10:01 -0400 Subject: [PATCH 09/21] build: update Dockle preview --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 8435e3a7..1e9319f3 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 8435e3a7ada906521fd66513ee05ac224e71c9a5 +Subproject commit 1e9319f369e2d2c07e24d4c28884b1c2452e956e From 1e82905e09b5c2dbfa991799e02881a3d7a64327 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 21:34:39 -0400 Subject: [PATCH 10/21] build: update Dockle preview --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 1e9319f3..5f9783de 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 1e9319f369e2d2c07e24d4c28884b1c2452e956e +Subproject commit 5f9783deb31c725fb704f4b462dcaa42a1798d24 From 98d4b250e24baed0240ee651f3c4e129644e1b01 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 23:38:05 -0400 Subject: [PATCH 11/21] chore(docs): update dockle renderer --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 5f9783de..a61a0dd0 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 5f9783deb31c725fb704f4b462dcaa42a1798d24 +Subproject commit a61a0dd0350cc9fbc28c9b483fdd7ebfbb6fa2e7 From 21091eacbe11bfb55e77bed20919a8b9257cef37 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 23:42:43 -0400 Subject: [PATCH 12/21] chore(docs): update dockle security fix --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index a61a0dd0..88042d78 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit a61a0dd0350cc9fbc28c9b483fdd7ebfbb6fa2e7 +Subproject commit 88042d78710b2ed0eedec603bda940103ed776be From 025ad7afa5dbb48cec4c13d11d24f0b8edf1bc38 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 23:46:42 -0400 Subject: [PATCH 13/21] chore(docs): update dockle quality fixes --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 88042d78..7e66cbf3 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 88042d78710b2ed0eedec603bda940103ed776be +Subproject commit 7e66cbf3e697fa2e907070f65e18873bf23ca1d5 From ddbfa9c615164d7a96d7a350e7b591058b40b7cb Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 11:12:46 -0400 Subject: [PATCH 14/21] fix(docs): use native Dockle tabs --- README.md | 89 +++++++++++++++++++++++++++++++++------------- third-party/dockle | 2 +- 2 files changed, 65 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 26ec98dd..5ca82c68 100644 --- a/README.md +++ b/README.md @@ -36,19 +36,32 @@ This fork adds the following features: ## 🖼️ Screenshots -@tabs{ -@tab{Linux|:| +
+ +
+Linux + ![Linux tray menu](docs/images/tray_menu_left_click_linux.png) ![Linux notification](docs/images/tray_notification_svg_icon_linux.png) -} -@tab{macOS|:| + +
+ +
+macOS + ![macOS tray menu](docs/images/tray_menu_left_click_macos.png) -} -@tab{Windows|:| + +
+ +
+Windows + ![Windows tray menu](docs/images/tray_menu_left_click_windows.png) ![Windows notification](docs/images/tray_notification_svg_icon_windows.png) -} -} + +
+ +
## 🖥️ Supported platforms @@ -67,39 +80,70 @@ This fork adds the following features: Install either Qt6 _or_ Qt5. -@tabs{ -@tab{Arch|:|```bash +
+ +
+Arch + +```bash # Qt6 sudo pacman -S qt6-base qt6-svg # Qt5 sudo pacman -S qt5-base qt5-svg -```} -@tab{Debian/Ubuntu|:|```bash +``` + +
+ +
+Debian/Ubuntu + +```bash # Qt6 sudo apt install qt6-base-dev qt6-svg-dev # Qt5 sudo apt install qtbase5-dev libqt5svg5-dev -```} -@tab{Fedora|:|```bash +``` + +
+ +
+Fedora + +```bash # Qt6 sudo dnf install qt6-qtbase-devel qt6-qtsvg-devel # Qt5 sudo dnf install qt5-qtbase-devel qt5-qtsvg-devel -```} -@tab{macOS|:|```bash +``` + +
+ +
+macOS + +```bash brew install cmake ninja qtbase qtsvg -```} -@tab{Windows (MSYS2 UCRT64)|:|```bash +``` + +
+ +
+Windows (MSYS2 UCRT64) + +```bash pacman -S mingw-w64-ucrt-x86_64-cmake \ mingw-w64-ucrt-x86_64-ninja \ mingw-w64-ucrt-x86_64-toolchain \ mingw-w64-ucrt-x86_64-qt6-base \ mingw-w64-ucrt-x86_64-qt6-svg -```} -} +``` + +
+ +
## 🛠️ Building @@ -186,8 +230,3 @@ array must have text field set to NULL. This software is distributed under [MIT license](http://www.opensource.org/licenses/mit-license.php), so feel free to integrate it in your commercial products. - -
- - [TOC] -
diff --git a/third-party/dockle b/third-party/dockle index 7e66cbf3..45f316a9 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 7e66cbf3e697fa2e907070f65e18873bf23ca1d5 +Subproject commit 45f316a9c1be76ad3c1293934f9d501c38b1e0f5 From 971626a7bb1da00cc226869b812e07338625cf96 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 11:27:31 -0400 Subject: [PATCH 15/21] chore(docs): update Dockle --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 45f316a9..4704e1c1 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 45f316a9c1be76ad3c1293934f9d501c38b1e0f5 +Subproject commit 4704e1c12c17d28346174d2bd6593a2278fa44e7 From fe64f8f576da7c175ae9d9778158343291ca919a Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 11:33:35 -0400 Subject: [PATCH 16/21] fix(docs): update the Dockle build environment --- .readthedocs.yaml | 1 + third-party/dockle | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 784b56b8..dcc57cfc 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,7 @@ version: 2 build: os: ubuntu-24.04 tools: + nodejs: "22" python: "miniconda-latest" jobs: build: diff --git a/third-party/dockle b/third-party/dockle index 4704e1c1..791b0698 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 4704e1c12c17d28346174d2bd6593a2278fa44e7 +Subproject commit 791b0698aaddcf566979953406efcab879a07279 From bd4e9eff4cda7970ad8adf91e1e98767dd81e0ca Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 11:37:39 -0400 Subject: [PATCH 17/21] chore(docs): update Dockle --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 791b0698..06fca326 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 791b0698aaddcf566979953406efcab879a07279 +Subproject commit 06fca3263a04bbf50fe874c1bf318460328842b6 From b457d822fc01734a19a88c39171803402385dbb1 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 20:56:23 -0400 Subject: [PATCH 18/21] docs: use dockle 2026.919.233535 --- .readthedocs.yaml | 2 +- third-party/dockle | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index dcc57cfc..5011c067 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,7 +8,7 @@ version: 2 build: os: ubuntu-24.04 tools: - nodejs: "22" + nodejs: "24" python: "miniconda-latest" jobs: build: diff --git a/third-party/dockle b/third-party/dockle index 06fca326..8a8e67f8 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 06fca3263a04bbf50fe874c1bf318460328842b6 +Subproject commit 8a8e67f8525c78c727053177c61469a3e7c958f1 From f75ba087ad8bb7031e35f924c5174116950db823 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 23:12:52 -0400 Subject: [PATCH 19/21] docs: update Dockle and CrowdIn integration --- dockle.toml | 7 +++++++ docs/crowdin.js | 1 + third-party/dockle | 2 +- 3 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/crowdin.js diff --git a/dockle.toml b/dockle.toml index 911e4ccd..4700faed 100644 --- a/dockle.toml +++ b/dockle.toml @@ -22,4 +22,11 @@ home = true [targets.doxygen] inputs = ["README.md", "src"] image_paths = ["docs/images"] +extra_stylesheets = [ + "https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@2026.920.12131/dist/crowdin-dockle-css.css", +] +extra_javascript = [ + "https://cdn.jsdelivr.net/npm/@lizardbyte/shared-web@2026.920.12131/dist/crowdin.js", + "docs/crowdin.js", +] main_page = "README.md" diff --git a/docs/crowdin.js b/docs/crowdin.js new file mode 100644 index 00000000..8160fd18 --- /dev/null +++ b/docs/crowdin.js @@ -0,0 +1 @@ +globalThis.initCrowdIn('LizardByte-docs', 'dockle') diff --git a/third-party/dockle b/third-party/dockle index 8a8e67f8..71da972f 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 8a8e67f8525c78c727053177c61469a3e7c958f1 +Subproject commit 71da972f1cb205f30237872a453a2bbc15fda88b From 1076b672e0579bd10818787597e56594a7e4ad82 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 20 Sep 2026 00:35:04 -0400 Subject: [PATCH 20/21] chore(deps): update Dockle to v2026.920.41323 --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 71da972f..4d01fc8c 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 71da972f1cb205f30237872a453a2bbc15fda88b +Subproject commit 4d01fc8cd66e7ff6acc62823fc144ac11ebf3c1e From c9e524f35499cc982f73d3a518cf7d497671bec1 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 20 Sep 2026 09:55:10 -0400 Subject: [PATCH 21/21] chore(deps): update Dockle to v2026.920.132930 --- third-party/dockle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/third-party/dockle b/third-party/dockle index 4d01fc8c..c1bca827 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 4d01fc8cd66e7ff6acc62823fc144ac11ebf3c1e +Subproject commit c1bca827d905e3e64cc6663488f5f741e17e681a