Add CI workflow to auto-update Doxygen docs on gh-pages branch - #266
Merged
Conversation
Triggers on every push to main. Checks out gh-pages to the workspace root (preserving the doxygen-awesome-css submodule at the expected relative path) and main into ./sly1/, then replicates the manual steps in generate.sh: strips `#include "common.h"` from headers, runs doxygen, and force-commits the updated html/ directory back to gh-pages. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011NDfvdWjURZNnXERVyz8o7
Dry run revealed two issues: - mv html/ .. fails when html/ already exists in the gh-pages checkout; add rm -rf html before generating (mirrors generate.sh behaviour) - PROJECT_LOGO = logo.png expects the file in the doxygen working dir, but it lives at docs/logo.png; copy it into place before running doxygen Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011NDfvdWjURZNnXERVyz8o7
TheOnlyZac
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Actions workflow to automatically regenerate and publish Doxygen documentation to the gh-pages branch whenever main is updated, aligning docs publishing with the existing manual generation steps.
Changes:
- Introduces
.github/workflows/doxygen.ymlto run on pushes tomain. - Checks out
gh-pages(publish target) andmain(source), preprocesses headers, runs Doxygen, and commitshtml/updates back togh-pages.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Triggers on every push to main. Checks out
gh-pagesandmaininto ./sly1/, then replicates the manual stepsin generate.sh: strips
#include "common.h"from headers, runs doxygen, and force-commits the updated html/ directory back to gh-pages.Co-Authored-By: Claude Sonnet 4.6 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_011NDfvdWjURZNnXERVyz8o7