Skip to content
Open
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 @@ -44,5 +44,6 @@
build/
cmake-*/

# doxyconfig
docs/doxyconfig*
# Dockle
/.dockle/
/_site/
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 @@ -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)
Expand Down
132 changes: 76 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,31 @@ This fork adds the following features:

## 🖼️ Screenshots

<div class="tabbed">
<ul>
<li><b class="tab-title">Linux</b><br>
<div class="dockle-tabs">

<details open>
<summary>Linux</summary>

![Linux tray menu](docs/images/tray_menu_left_click_linux.png)
![Linux notification](docs/images/tray_notification_svg_icon_linux.png)

</li>
<li><b class="tab-title">macOS</b><br>
</details>

<details>
<summary>macOS</summary>

![macOS tray menu](docs/images/tray_menu_left_click_macos.png)

</li>
<li><b class="tab-title">Windows</b><br>
</details>

<details>
<summary>Windows</summary>

![Windows tray menu](docs/images/tray_menu_left_click_windows.png)
![Windows notification](docs/images/tray_notification_svg_icon_windows.png)

</li>
</ul>
</details>

</div>

## 🖥️ Supported platforms
Expand All @@ -75,48 +80,68 @@ This fork adds the following features:

Install either Qt6 _or_ Qt5.

<div class="tabbed">

- <b class="tab-title">Arch</b>
```bash
# Qt6
sudo pacman -S qt6-base qt6-svg

# Qt5
sudo pacman -S qt5-base qt5-svg
```

- <b class="tab-title">Debian/Ubuntu</b>
```bash
# Qt6
sudo apt install qt6-base-dev qt6-svg-dev

# Qt5
sudo apt install qtbase5-dev libqt5svg5-dev
```

- <b class="tab-title">Fedora</b>
```bash
# Qt6
sudo dnf install qt6-qtbase-devel qt6-qtsvg-devel

# Qt5
sudo dnf install qt5-qtbase-devel qt5-qtsvg-devel
```

- <b class="tab-title">macOS</b>
```bash
brew install cmake ninja qtbase qtsvg
```

- <b class="tab-title">Windows (MSYS2 UCRT64)</b>
```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
```
<div class="dockle-tabs">

<details open>
<summary>Arch</summary>

```bash
# Qt6
sudo pacman -S qt6-base qt6-svg

# Qt5
sudo pacman -S qt5-base qt5-svg
```

</details>

<details>
<summary>Debian/Ubuntu</summary>

```bash
# Qt6
sudo apt install qt6-base-dev qt6-svg-dev

# Qt5
sudo apt install qtbase5-dev libqt5svg5-dev
```

</details>

<details>
<summary>Fedora</summary>

```bash
# Qt6
sudo dnf install qt6-qtbase-devel qt6-qtsvg-devel

# Qt5
sudo dnf install qt5-qtbase-devel qt5-qtsvg-devel
```

</details>

<details>
<summary>macOS</summary>

```bash
brew install cmake ninja qtbase qtsvg
```

</details>

<details>
<summary>Windows (MSYS2 UCRT64)</summary>

```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
```

</details>

</div>

Expand Down Expand Up @@ -205,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.

<details style="display: none;">
<summary></summary>
[TOC]
</details>
32 changes: 32 additions & 0 deletions dockle.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
[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 = "."
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"
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