-
Notifications
You must be signed in to change notification settings - Fork 69
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 coverage report to documentation #481
Conversation
If we are on the automatic creation of the documentaion, we could also think about automatic deployment to gh-pages.
Following this description here: https://github.com/JamesIves/github-pages-deploy-action In case this seems to be useful, I'll can either provide a new PR or just add to this one. |
I will add the deployment in this PR. For the testing phase I will convert it to draft and notify you when it is ready. |
I changed the workflows accordingly.
|
doc/pages/Code-Coverage.md
Outdated
@@ -16,3 +16,6 @@ make test | |||
make coverage | |||
``` | |||
The final report is in ```~/build/coverageReport/index.html``` | |||
|
|||
### coverage report of the current master branch |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Coverage Report
doc/pages/Code-Coverage.md
Outdated
@@ -16,3 +16,6 @@ make test | |||
make coverage | |||
``` | |||
The final report is in ```~/build/coverageReport/index.html``` | |||
|
|||
### coverage report of the current master branch | |||
The coverage report of the current master branch can be accesed `by clicking here <coverageReport/index.html>`_ now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The most recent coverage report is linked here.
With this PR the coverage report is added to the documentation.
The Github action is adopted to copy the report into the documentation part and a link to the files is added.
In case of a manual build of the documentation the coverage report has to be copied by hand to the right location. In the build folder it is done by: