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.

Sign up for GitHub

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

Jump to bottom

Include documentation as mandatory CI #1053

Merged
merged 11 commits into from
Dec 8, 2023
Merged

Include documentation as mandatory CI #1053

merged 11 commits into from
Dec 8, 2023

Conversation

sethrj
Copy link
Member

@sethrj sethrj commented Dec 7, 2023

This updates the build flags and workflow to:

  • require documentation to be built as a precondition to the "full" CI jobds
  • reduce the documentation build time for pull requests
  • mark warnings as errors for PRs
  • don't error when "push" to develop (in case something odd happens due to the change from disabling to enabling dot)
  • fix a few warnings and suppress some for the doxygen 1.9.1 that's in ubunto

@sethrj sethrj added documentation Improvements or additions to documentation, examples, and tests minor Minor internal changes or fixes (including CI updates) labels Dec 7, 2023
@sethrj sethrj requested a review from pcanal December 7, 2023 14:02
@sethrj sethrj mentioned this pull request Dec 7, 2023
Merged
11 tasks
pcanal
pcanal approved these changes Dec 8, 2023
View reviewed changes
Copy link
Contributor

@pcanal pcanal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sethrj sethrj merged commit e8aee90 into celeritas-project:develop Dec 8, 2023
20 checks passed
@sethrj sethrj deleted the doxygen-required branch December 8, 2023 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pcanal pcanal pcanal approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation, examples, and tests minor Minor internal changes or fixes (including CI updates)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@sethrj @pcanal