Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@
build/
cmake-*/

# doxyconfig
docs/doxyconfig*
# Dockle
/.dockle/
/_site/

# CTest
Testing/
6 changes: 3 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[submodule "third-party/doxyconfig"]
path = third-party/doxyconfig
url = https://github.com/LizardByte/doxyconfig.git
[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
Expand Down
27 changes: 14 additions & 13 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,23 @@ version: 2
build:
os: ubuntu-24.04
tools:
nodejs: "24"
python: "miniconda-latest"
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"
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"

# 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
Expand Down
3 changes: 2 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ endif()
#
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)
Expand Down
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,3 @@ ninja -C build
## ❓ Support

Our support methods are listed in our [LizardByte Docs](https://lizardbyte.readthedocs.io/latest/about/support.html).

<details style="display: none;">
<summary></summary>
[TOC]
</details>
30 changes: 30 additions & 0 deletions dockle.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
[project]
name = "libdisplaydevice"
version = "0.0.0"
description = "C++ library to modify display devices."
repository = "https://github.com/LizardByte/libdisplaydevice"
logo = "https://raw.githubusercontent.com/LizardByte/.github/refs/heads/master/branding/logos/logo.svg"

[build]
output = "_site"
work = ".dockle"
strict = true
clean = true

[[targets]]
name = "api"
title = "libdisplaydevice documentation"
framework = "doxygen"
source = "."
home = true

[targets.doxygen]
inputs = ["README.md", "src"]
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"
41 changes: 0 additions & 41 deletions docs/Doxyfile

This file was deleted.

1 change: 1 addition & 0 deletions docs/crowdin.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
globalThis.initCrowdIn('LizardByte-docs', 'dockle')
1 change: 1 addition & 0 deletions third-party/dockle
Submodule dockle added at c1bca8
1 change: 0 additions & 1 deletion third-party/doxyconfig
Submodule doxyconfig deleted from 419127
Loading