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 Doxygen CI job and enforce Doxygen warnings #2716

Open
ChrisThrasher opened this issue Oct 2, 2023 · 1 comment
Open

Add Doxygen CI job and enforce Doxygen warnings #2716

ChrisThrasher opened this issue Oct 2, 2023 · 1 comment

Comments

@ChrisThrasher
Copy link
Member

Subject of the issue

Doxygen has some helpful warnings that we’re currently ignoring. We ought to elevator those warnings to errors then add a CI job to build the docs to prevent regressions. For example these warnings caught a docs bug for an sf::Context constructor that remained unnoticed for a year or more.

@ChrisThrasher
Copy link
Member Author

Here is where I generate docs for the sake of catching warnings: https://github.com/ChrisThrasher/argon/blob/fa7b4b75d49eefb1cbeb7bc236dbdcc14e80e407/.github/workflows/ci.yml#L132-L147

Here is where I generate docs for the sake of deploying to GitHub Pages: https://github.com/ChrisThrasher/argon/blob/fa7b4b75d49eefb1cbeb7bc236dbdcc14e80e407/.github/workflows/cd.yml#L15-L44

In our case we don't care about GitHub pages per se but between these two jobs we should be able to figure out the best way to generate docs and create a release artifact from them so we can easily deploy them to the website.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Needs Work
Development

No branches or pull requests

2 participants