Add doxygen docs to Github Pages#8329
Conversation
|
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. 
|
|
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. |
This reverts commit f741604.
|
That seems to not have worked - it did go farther, but it still has permission-related errors: |
I don't think that will work, unless we set things up differently here. From that action's readme: |
|
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
left a comment
JohannesLorenz
left a comment
There was a problem hiding this comment.
What I checked:
- Code
- Style
| run: | | ||
| cmake --build fltk/build | ||
| sudo cmake --install fltk/build --prefix /usr | ||
| - name: Configure |
There was a problem hiding this comment.
A lot of classes/types by Doxygen (almost all) are not by us (Lv2, Sord, Asio, Calf, ...).
As you said in Discord, you would like to keep it. I leave the comment here for discussion.
|
I've now specified a main page, as it before was showing the FLAC API main page. We should probably make a specific main page for the code docs, but for now I put the repo's README.md file as the main page: |
rubiefawn
left a comment
rubiefawn
left a comment
There was a problem hiding this comment.
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.
|
Oh, nice. Do I apply the changes here? I see you've done something similar but slightly different in #8361. |
|
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) |
4 participants
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
buildworkflow 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: