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

Doxygen Mathjax fix and warnings build status #1580

Merged
merged 2 commits into from
Nov 25, 2016

Conversation

bilke
Copy link
Member

@bilke bilke commented Nov 25, 2016

  • Fixed Mathjax (formulas)
  • Changed Jenkins to mark build as unstable (yellow) when there are new Doxygen warnings

@chleh
Copy link
Collaborator

chleh commented Nov 25, 2016

But what will be the policy for new doxygen warnings? Will they have to be fixed immediately in the respective PR? Or later on in some Documentation-Specific PR? Furthermore, Doxygen warnings cover only part of the documentation. E.g., they don't cover the keyword docu. What will be the procedure for that in the future? I assume this PR was @endJunction's idea... 😄

@endJunction
Copy link
Member

endJunction commented Nov 25, 2016

At some point (next week) there will be only a dozen doxygen warnings at all, then the "new warning" will be armed properly, i.e. the PR will not pass (or at least report something). (Let's see first, what this "mark unstable" looks like.)

The keywords will be also covered because the prj file references will not be resolved if there is no prj....keyword.md. In the following stages the keyword.md files will be filled with documentation.

@endJunction endJunction merged commit e29f42a into ufz:master Nov 25, 2016
@bilke bilke deleted the doxygen-fix branch November 25, 2016 19:22
@bilke
Copy link
Member Author

bilke commented Nov 25, 2016

I noticed one problem:

A PR creates a new Jenkins job (PR-xxxx) but a new job has no previous builds and therefore the warnings parser cannot find out if there were new warnings introduced.. So this will only popup once the PR is merged into master..

@ogsbot
Copy link
Member

ogsbot commented Jun 19, 2020

OpenGeoSys development has been moved to GitLab.

See this pull request on GitLab.

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 this pull request may close these issues.

4 participants