Skip to content
Merged
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
3b4363b
first doxygen attempt
yohannd1 Mar 25, 2026
d1ffde0
investigate why it's not working...
yohannd1 Mar 25, 2026
3e0b424
tab? really?
yohannd1 Mar 25, 2026
237dc96
not sure what I'm doing anymore
yohannd1 Mar 25, 2026
e1205a3
small change for debug
yohannd1 Mar 25, 2026
3c3998c
install doxygen
yohannd1 Mar 25, 2026
148159b
...
yohannd1 Mar 25, 2026
ff848ee
organize doxygen stuff, and fix permissions
yohannd1 Mar 25, 2026
f741604
disable running doxygen on PRs
yohannd1 Mar 25, 2026
504b7b6
Revert "disable running doxygen on PRs"
yohannd1 Mar 26, 2026
79075f2
experiment removing some dependencies and make configs
yohannd1 Mar 26, 2026
8a1cab8
remove many dependencies
yohannd1 Mar 26, 2026
30e9a6e
try using minimal dependencies
yohannd1 Mar 26, 2026
79db7dc
reverting last change and removing more make options
yohannd1 Mar 26, 2026
6e5b4bc
improve + test doxygen check
yohannd1 Mar 26, 2026
dd27fb5
fix typo...
yohannd1 Mar 26, 2026
6247ebd
ok, it seems it worked!
yohannd1 Mar 26, 2026
069f3ab
improve doxygen check
yohannd1 Mar 27, 2026
fd4371e
it worked!
yohannd1 Mar 27, 2026
0a6ac1e
experiment using less dependencies
yohannd1 Mar 27, 2026
6eb768b
even less dependencies
yohannd1 Mar 27, 2026
1d3526a
this should make it error properly in windows as well?
yohannd1 Apr 2, 2026
26b8451
use separate cmake file for handling doxygen error
yohannd1 Apr 2, 2026
fb407da
try not using fluidsynth
yohannd1 Apr 4, 2026
959a94e
specify a main page
yohannd1 Apr 4, 2026
c789c88
restrict action for branches (don't include PRs)
yohannd1 Apr 7, 2026
17dd4c4
addressing some comments
yohannd1 Apr 15, 2026
d69c29a
update more action dependencies
yohannd1 Apr 15, 2026
1065be8
remove many lib deps
yohannd1 Apr 20, 2026
3a01022
add qt5svg back
yohannd1 Apr 20, 2026
8010316
add back qt5x11extras
yohannd1 Apr 20, 2026
74c81fb
add required sndfile
yohannd1 Apr 20, 2026
86d7829
add back fftw
yohannd1 Apr 20, 2026
a18d7ca
add back samplerate
yohannd1 Apr 20, 2026
3dcc28f
add back xcb
yohannd1 Apr 20, 2026
751c2d6
addback xcb keysyms/util
yohannd1 Apr 20, 2026
c3db15e
add back list moreutils
yohannd1 Apr 20, 2026
063ac50
install doxygen separately through a github action
yohannd1 Apr 21, 2026
a807160
Apply suggestions from code review
yohannd1 Apr 22, 2026
e55dcf4
attempt to minimize doc dependencies through a dedicated CMakeLists.txt
yohannd1 Apr 25, 2026
48e6d34
Merge branch 'doxygen' of github.com:yohannd1/lmms-fork into doxygen
yohannd1 Apr 25, 2026
3e6e17a
source file adjustments...
yohannd1 Apr 25, 2026
fc54866
move doc_fail back into the error branch
yohannd1 Apr 30, 2026
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
84 changes: 84 additions & 0 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
name: doxygen
'on': [push, pull_request]
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions:
contents: read
pages: write
id-token: write
jobs:
linux-x86_64:
name: linux-x86_64
runs-on: ubuntu-22.04
Comment thread
yohannd1 marked this conversation as resolved.
Outdated
env:
MAKEFLAGS: -j2
steps:
- name: Configure git
run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
- name: Check out
uses: actions/checkout@v3
Comment thread
yohannd1 marked this conversation as resolved.
Outdated
with:
fetch-depth: 0
submodules: recursive
- name: Install packages
run: |
sudo apt-get update -y
sudo apt-get install -y --no-install-recommends \
cmake \
make \
fluid \
libasound2-dev \
libc6-dev \
libfftw3-dev \
libfluidsynth-dev \
libgig-dev \
libgtk2.0-0 \
libjack-jackd2-dev \
liblilv-dev \
liblist-moreutils-perl \
libmp3lame-dev \
libogg-dev \
libqt5svg5-dev \
libqt5x11extras5-dev \
libsamplerate0-dev \
libsdl2-dev \
libsndfile1-dev \
libsoundio-dev \
libstk-dev \
libsuil-dev \
libvorbis-dev \
libx11-xcb-dev \
libxcb-keysyms1-dev \
libxcb-util0-dev \
libxft-dev \
libxinerama-dev \
libxml2-utils \
libxml-perl \
lsb-release \
lv2-dev \
portaudio19-dev \
qt5-qmake \
qtbase5-dev \
qtbase5-dev-tools \
qtbase5-private-dev \
qttools5-dev-tools \
qtwayland5 \
stk \
doxygen
- name: Configure
Comment thread
yohannd1 marked this conversation as resolved.
run: |
source /opt/qt5*/bin/qt5*-env.sh || true
cmake -S . -B build $CMAKE_OPTS
- name: Build docs
run: cmake --build build --target doc
Comment thread
yohannd1 marked this conversation as resolved.
Comment thread
JohannesLorenz marked this conversation as resolved.
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload generated website
uses: actions/upload-pages-artifact@v3
with:
path: 'build/doc/doc/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
11 changes: 7 additions & 4 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FIND_PACKAGE(Doxygen)

if(DOXYGEN_FOUND)
set(INPUTDIRS
if(Doxygen_FOUND OR DOXYGEN_FOUND)
set(INPUTDIRS
"\"${CMAKE_CURRENT_SOURCE_DIR}../src/core\"
\"${CMAKE_CURRENT_SOURCE_DIR}../src/gui\"
\"${CMAKE_CURRENT_SOURCE_DIR}../src/tracks\"
Expand All @@ -14,7 +14,10 @@ if(DOXYGEN_FOUND)
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
COMMENT "Generating API documentation with Doxygen"
SOURCES Doxyfile.in)
endif(DOXYGEN_FOUND)
else()
ADD_CUSTOM_TARGET(doc
COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_SOURCE_DIR}/doc_fail.cmake
VERBATIM)
Comment thread
rubiefawn marked this conversation as resolved.
Outdated
endif()

ADD_SUBDIRECTORY(bash-completion)

1 change: 1 addition & 0 deletions doc/doc_fail.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
message(FATAL_ERROR "Doxygen was not found. Unable to generate docs.")
Loading