From 004818141d2ba7b2f800053135b953edba4679fd Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 18:17:44 -0400 Subject: [PATCH 01/21] docs: migrate documentation to Dockle --- .gitignore | 5 +++-- .gitmodules | 8 +++---- .readthedocs.yaml | 25 +++++++-------------- CMakeLists.txt | 3 ++- LICENSES/license-map.md | 6 ++--- dockle.toml | 35 +++++++++++++++++++++++++++++ docs/Doxyfile | 50 ----------------------------------------- docs/development.md | 10 ++++----- third-party/dockle | 1 + third-party/doxyconfig | 1 - 10 files changed, 61 insertions(+), 83 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 ebc03dad..8dbbc1ab 100644 --- a/.gitignore +++ b/.gitignore @@ -13,5 +13,6 @@ cmake-build-*/ /artifacts/ /docs/controller-research/ -# 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 8103c50d..bad58376 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -137,7 +137,8 @@ if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) endif() 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_EXAMPLES) diff --git a/LICENSES/license-map.md b/LICENSES/license-map.md index 55ddae2b..ebbb843e 100644 --- a/LICENSES/license-map.md +++ b/LICENSES/license-map.md @@ -23,8 +23,8 @@ texts for that reason.
-| Previous | Next | -|:--------------------------------------|-------------------------------------------------------------:| -| [Development](../docs/development.md) | [Source Code](../third-party/doxyconfig/docs/source_code.md) | +| Previous | Next | +|:--------------------------------------|-----:| +| [Development](../docs/development.md) | |
diff --git a/dockle.toml b/dockle.toml new file mode 100644 index 00000000..617f5a96 --- /dev/null +++ b/dockle.toml @@ -0,0 +1,35 @@ +[project] +name = "libvirtualhid" +version = "0.0.0" +description = "Cross-platform C++ library for virtual HID devices." +repository = "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/LizardByte/libvirtualhid" +logo = "libvirtualhid.svg" +favicon = "libvirtualhid.ico" + +[build] +output = "_site" +work = ".dockle" +strict = true +clean = true + +[[targets]] +name = "api" +title = "libvirtualhid documentation" +framework = "doxygen" +source = "." + +[targets.doxygen] +inputs = [ + "README.md", + "docs/end-user-gamepad-guide.md", + "docs/usage.md", + "docs/platform-support.md", + "docs/windows-driver.md", + "docs/todo.md", + "docs/streaming-host-integration.md", + "docs/development.md", + "LICENSES/license-map.md", + "examples", + "src/include", +] +main_page = "README.md" diff --git a/docs/Doxyfile b/docs/Doxyfile deleted file mode 100644 index fdf482a4..00000000 --- a/docs/Doxyfile +++ /dev/null @@ -1,50 +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.libvirtualhid -DOCSET_PUBLISHER_ID = dev.lizardbyte.libvirtualhid.documentation -PROJECT_BRIEF = "Cross-platform C++ library for virtual HID devices." -PROJECT_ICON = ../libvirtualhid.svg -PROJECT_LOGO = ../libvirtualhid.svg -PROJECT_NAME = libvirtualhid - -# project specific settings -DOT_GRAPH_MAX_NODES = 50 -INCLUDE_PATH = -WARN_IF_UNDOCUMENTED = YES - -# files and directories to process -USE_MDFILE_AS_MAINPAGE = ../README.md -INPUT = ../README.md \ - end-user-gamepad-guide.md \ - usage.md \ - platform-support.md \ - windows-driver.md \ - todo.md \ - streaming-host-integration.md \ - development.md \ - ../LICENSES/license-map.md \ - ../examples \ - ../third-party/doxyconfig/docs/source_code.md \ - ../src/include diff --git a/docs/development.md b/docs/development.md index c183d0e3..2870cbda 100644 --- a/docs/development.md +++ b/docs/development.md @@ -15,8 +15,8 @@ src/platform/macos/ macOS CoreGraphics keyboard and mouse backend examples/ Minimal consumers and platform smoke tests tests/ Unit and integration tests cmake/ Package config and helper modules -docs/ Project documentation and Doxygen settings -third-party/doxyconfig/ LizardByte Doxygen configuration submodule +docs/ Project documentation +third-party/dockle/ LizardByte documentation toolchain submodule third-party/googletest/ GoogleTest submodule ``` @@ -62,9 +62,9 @@ cmake-build-debug/tests/test_libvirtualhid ## Documentation -Documentation is generated by the LizardByte `doxyconfig` submodule. The project -Doxygen input is defined in `docs/Doxyfile`. The docs target combines that -file with the shared `doxyconfig` settings at build time. +Documentation is generated by Dockle. The authored inputs and project-specific +Doxygen settings are declared in `dockle.toml`; Dockle owns the generated +Doxyfile used by the CMake `docs` target. ```bash cmake --build cmake-build-debug-mingw-ucrt64-ninja --target docs 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 f4da52b448980ddce48efc28fe06c93a8251b19f Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 19:29:01 -0400 Subject: [PATCH 02/21] fix: refine Dockle migration --- .gitmodules | 8 ++++---- .readthedocs.yaml | 21 ++++++++++++++------- LICENSES/license-map.md | 8 -------- README.md | 8 -------- docs/development.md | 8 -------- docs/end-user-gamepad-guide.md | 8 -------- docs/platform-support.md | 8 -------- docs/streaming-host-integration.md | 8 -------- docs/todo.md | 8 -------- docs/usage.md | 8 -------- docs/windows-driver.md | 8 -------- third-party/dockle | 2 +- 12 files changed, 19 insertions(+), 84 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/LICENSES/license-map.md b/LICENSES/license-map.md index ebbb843e..2e1d3e4c 100644 --- a/LICENSES/license-map.md +++ b/LICENSES/license-map.md @@ -20,11 +20,3 @@ Every installed library distribution includes the MIT notice under `share/licenses/libvirtualhid`. The Windows driver MSI may include MIT-licensed helper components from this repository; packaged installs include both license texts for that reason. - -
- -| Previous | Next | -|:--------------------------------------|-----:| -| [Development](../docs/development.md) | | - -
diff --git a/README.md b/README.md index 531a5cc8..5328f7d0 100644 --- a/README.md +++ b/README.md @@ -197,11 +197,3 @@ licensed under the points to both complete license texts; see the [license map](https://github.com/LizardByte/libvirtualhid/blob/master/LICENSES/license-map.md) for the authoritative repository path and artifact assignments. - -
- -| Previous | Next | -|:---------|---------------------------------------------------------:| -| | [End-User Gamepad Guide](docs/end-user-gamepad-guide.md) | - -
diff --git a/docs/development.md b/docs/development.md index 2870cbda..aa0ca400 100644 --- a/docs/development.md +++ b/docs/development.md @@ -96,11 +96,3 @@ code and tests provide a better source of truth. - Evaluate an optional FreeBSD CUSE-backed `uhid(4)`-compatible device for direct HID consumers. This would supplement uinput; it is not equivalent to registering a virtual device with FreeBSD's kernel HID bus. - -
- -| Previous | Next | -|:------------------------------------------------------------|------------------------------------------:| -| [Streaming-Host Integration](streaming-host-integration.md) | [License Map](../LICENSES/license-map.md) | - -
diff --git a/docs/end-user-gamepad-guide.md b/docs/end-user-gamepad-guide.md index 5d82294d..a37148b2 100644 --- a/docs/end-user-gamepad-guide.md +++ b/docs/end-user-gamepad-guide.md @@ -290,11 +290,3 @@ reaching the library but the virtual device reports it incorrectly. The [Moonlight setup guide](https://github.com/moonlight-stream/moonlight-docs/wiki/Setup-Guide) links the official clients and their support resources. - -
- -| Previous | Next | -|:-------------------------|--------------------------:| -| [Overview](../README.md) | [Usage and API](usage.md) | - -
diff --git a/docs/platform-support.md b/docs/platform-support.md index b15d8693..37b23585 100644 --- a/docs/platform-support.md +++ b/docs/platform-support.md @@ -461,11 +461,3 @@ Native macOS virtual-HID gamepad support is planned. A future backend may use `IOHIDUserDevice`, DriverKit/HIDDriverKit, or a combination that preserves the same public API while documenting any signing, entitlement, and installer requirements. - -
- -| Previous | Next | -|:--------------------------|--------------------------------------------:| -| [Usage and API](usage.md) | [Windows Driver Package](windows-driver.md) | - -
diff --git a/docs/streaming-host-integration.md b/docs/streaming-host-integration.md index bccaa8a9..22deb5c1 100644 --- a/docs/streaming-host-integration.md +++ b/docs/streaming-host-integration.md @@ -68,11 +68,3 @@ The core API and adapter shape cover the major streaming-host requirements: - FreeBSD uinput gamepads and pointer devices, with basic PlayStation input and rumble but without Linux UHID-only PlayStation features. - Windows UMDF/VHF gamepad creation through an installed driver package. - -
- -| Previous | Next | -|:----------------|------------------------------:| -| [TODO](todo.md) | [Development](development.md) | - -
diff --git a/docs/todo.md b/docs/todo.md index b85bfc5c..e8d1460c 100644 --- a/docs/todo.md +++ b/docs/todo.md @@ -34,11 +34,3 @@ Proposed solution: 6. Treat generated capture files as local debugging artifacts by default. Only commit a generated capture later if it is reproducible, sanitized, and used by tests or documentation in a way that justifies keeping it. - -
- -| Previous | Next | -|:--------------------------------------------|------------------------------------------------------------:| -| [Windows Driver Package](windows-driver.md) | [Streaming-Host Integration](streaming-host-integration.md) | - -
diff --git a/docs/usage.md b/docs/usage.md index 9ee760ae..d8a9ff43 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -248,11 +248,3 @@ for every profile. The `misc1` button represents Share/Capture/Mic Mute-style controls and is available on the generic, Xbox Series, DualSense, and Switch Pro profiles; Xbox 360 and Xbox One do not advertise that extra button. - -
- -| Previous | Next | -|:----------------------------------------------------|----------------------------------------:| -| [End-User Gamepad Guide](end-user-gamepad-guide.md) | [Platform Support](platform-support.md) | - -
diff --git a/docs/windows-driver.md b/docs/windows-driver.md index 510dd7ba..98ce3a05 100644 --- a/docs/windows-driver.md +++ b/docs/windows-driver.md @@ -572,11 +572,3 @@ licensed under the LizardByte Source-Available License 1.0 (LB-SAL 1.0). See the [license map](../LICENSES/license-map.md) for the full repository license split. The MSI may also include MIT-licensed helper components from this repository, so packaged installs include both license texts. - -
- -| Previous | Next | -|:----------------------------------------|----------------:| -| [Platform Support](platform-support.md) | [TODO](todo.md) | - -
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 38b4c18acefa835eddff1b419f59488c134ac84b Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 19:31:52 -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 4290fc581f6b157402f492431ccde90672935fc0 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 19:41:35 -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 01fb6dd5bc73557753ea750f10d52af9311b0e28 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 20:00:08 -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 e2f380838a4369c86f4ebda22eafd74276b38efb Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 20:50:15 -0400 Subject: [PATCH 06/21] fix: refine Dockle documentation --- dockle.toml | 1 + third-party/dockle | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/dockle.toml b/dockle.toml index 617f5a96..91e4d97c 100644 --- a/dockle.toml +++ b/dockle.toml @@ -17,6 +17,7 @@ name = "api" title = "libvirtualhid documentation" framework = "doxygen" source = "." +home = true [targets.doxygen] inputs = [ 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 00e78b35ace3b2d49c391a38f745378c14b37670 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 20:53:53 -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 6691fdd243412dd6985aede12f050cda6cd27891 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 21:01:14 -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 63cd41ba72875b6962ba20dd26661b288f7a522d Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 21:10:10 -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 7ff7e09a4f0ba1daf18d1d2cac4638c3c21985ab Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 21:34:49 -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 a097a44143cb28785a7646ea2bc6a470ff1c5a72 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 23:38:07 -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 93640b593599cccbda67bda6996e8a3e1153f113 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 23:42:53 -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 f3d5c658b99df7e7e796aff6a2c73901262d43b9 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 18 Sep 2026 23:46:52 -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 ed8063d1ab703a2e25bcb6d924cf7b30c6043873 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 11:12:48 -0400 Subject: [PATCH 14/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 7e66cbf3..45f316a9 160000 --- a/third-party/dockle +++ b/third-party/dockle @@ -1 +1 @@ -Subproject commit 7e66cbf3e697fa2e907070f65e18873bf23ca1d5 +Subproject commit 45f316a9c1be76ad3c1293934f9d501c38b1e0f5 From e8835e292dfdbe9197bd5362b79685f688f26072 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 11:27:35 -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 5996511b62200f9964f7ca22c174b6a96f03a0d4 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 11:33:39 -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 146cb1b4bffef66b6c0368e91db0fbb31f636b74 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 11:37:47 -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 f2768791863560143d7794bf189fa7e488535d11 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 20:56:24 -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 3f9b04da8ef69c442730d0e11fd54a6321ce4ad7 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sat, 19 Sep 2026 23:13:10 -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 91e4d97c..f43fd5e9 100644 --- a/dockle.toml +++ b/dockle.toml @@ -33,4 +33,11 @@ inputs = [ "examples", "src/include", ] +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 34c4d82bf797e88c0d94e549853278edce4d599a Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 20 Sep 2026 00:35:27 -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 678763411355fd16e15fef77d2967d93278b58d4 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Sun, 20 Sep 2026 09:55:43 -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