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 documentation check to CI run, ensure no documentation warnings with WARN_AS_ERROR #2365

Closed
edwardhartnett opened this issue May 29, 2022 · 0 comments · Fixed by #2377
Closed

Comments

@edwardhartnett
Copy link
Contributor

Doxygen has a WARN_AS_ERROR setting.

This setting, when turned on, cause the documentation build to error out of there are any warnings.

Once existing warnings are cleared, this can be turned on, and a doxygen build added to the CI. After that, no PR will pass if it generates doxygen warnings. This is a great way to keep documentation working and the quality of doxygen good. Of course, it does not replace the review of documentation to ensure it makes sense. ;-)

But it is very helpful, we do it now with many NOAA repositories and it works well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant