Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add workflow to test doxygen build #66

Closed
stephprince opened this issue Aug 6, 2024 · 1 comment · Fixed by #67
Closed

add workflow to test doxygen build #66

stephprince opened this issue Aug 6, 2024 · 1 comment · Fixed by #67

Comments

@stephprince
Copy link
Collaborator

See discussion and commits in related PR here: #59

Add separate action to test docs build on PRs (without deploying the docs and with doxygen warnings elevated to errors) See the discussion here #56 (comment). The Doxygen settings to elevate warnings are here https://www.doxygen.nl/manual/config.html#cfg_warn_as_error. I think we want to set WARN_AS_ERROR = FAIL_ON_WARNINGS_PRINT so that Doxygen runs to the end, prints warnings as a single block, but then exits with a an error code. In this way we can see all the warnings (instead of failing after the first one) and all warnings are listed together to make them easier to review.

@stephprince
Copy link
Collaborator Author

there are currently warnings likely related to the doxygen version - this should also be updated

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 a pull request may close this issue.

1 participant