Skip to content

Add doxygen docs to Github Pages#8329

Merged
rubiefawn merged 43 commits into
LMMS:masterfrom
yohannd1:doxygen
May 13, 2026
Merged

Add doxygen docs to Github Pages#8329
rubiefawn merged 43 commits into
LMMS:masterfrom
yohannd1:doxygen

Conversation

@yohannd1

@yohannd1 yohannd1 commented Mar 25, 2026

Copy link
Copy Markdown
Contributor

This PR adds a github workflow that runs doxygen on the codebase and uploads the generated HTML pages to Github Pages. My aim with this is to make reading the docs easier and browsing through the documentation simpler.

This workflow was based off the build workflow already present in the repo, plus some prior Github Pages experiments I've worked on.

As the workflow depends on access to Github Pages, it's not working in the PR. Meanwhile, you can check it on my fork and its github pages instance.

Things to consider:

@yohannd1

Copy link
Copy Markdown
Contributor Author

Note that the CI run inside the PR does not work fully, as it is denied acess to github pages. Not sure if there's a way to work around that. In fact, I'll be disabling this run on PRs for now.

image

@messmerd

Copy link
Copy Markdown
Member

Following the advice from this Stack Overflow article, I just set the GitHub Pages source for this repo to GitHub Actions.

Try again and see if it works now.

@JohannesLorenz
JohannesLorenz self-requested a review March 26, 2026 00:08
@yohannd1

Copy link
Copy Markdown
Contributor Author

That seems to not have worked - it did go farther, but it still has permission-related errors:
image
I will now be trying rossjrw/pr-preview-action, which might be able to solve this.

@messmerd

messmerd commented Mar 26, 2026

Copy link
Copy Markdown
Member

I will now be trying rossjrw/pr-preview-action, which might be able to solve this.

I don't think that will work, unless we set things up differently here.

From that action's readme:
image

@yohannd1

Copy link
Copy Markdown
Contributor Author

Ah, I see. From what I've read here it seems it is possible to adapt the workflow here, but I'm not sure if it would be worth it - pushing tons of generated HTML and graph files of tons of PRs is probably going to bloat the repo a lot.

@JohannesLorenz JohannesLorenz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I checked:

  • Code
  • Style

Comment thread .github/workflows/doxygen.yml Outdated
Comment thread .github/workflows/doxygen.yml
Comment thread .github/workflows/doxygen.yml
Comment thread .github/workflows/doxygen.yml
Comment thread .github/workflows/doxygen.yml Outdated
Comment thread .github/workflows/doxygen.yml Outdated
Comment thread .github/workflows/doxygen.yml Outdated

@rubiefawn rubiefawn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did some local testing and it looks like we can get rid of the old relative path hacks by just using @CMAKE_SOURCE_DIR@ instead.

Comment thread doc/Doxyfile.in Outdated
Comment thread doc/Doxyfile.in Outdated
@yohannd1

Copy link
Copy Markdown
Contributor Author

Oh, nice. Do I apply the changes here? I see you've done something similar but slightly different in #8361.

@rubiefawn

rubiefawn commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

I'll be rebasing #8361 once this PR is merged anyways, so I suppose it doesn't matter that much lol

(The "local testing" got out of control and ended up as that other PR)

Comment thread doc/CMakeLists.txt Outdated
@rubiefawn

Copy link
Copy Markdown
Contributor

What, if anything, does this PR need before it's ready for merge?

image

@yohannd1

Copy link
Copy Markdown
Contributor Author

I don't think there is anything pending here. I'd like to make a detailed initial page guiding through the codebase but that should go into a separate PR.

@rubiefawn
rubiefawn merged commit 566fe8a into LMMS:master May 13, 2026
11 checks passed
@yohannd1
yohannd1 deleted the doxygen branch July 8, 2026 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants