-
Notifications
You must be signed in to change notification settings - Fork 277
Fix doxygen in cmake #5768
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
Fix doxygen in cmake #5768
Conversation
This has been broken for 3 years, ever since doxygen.cfg was renamed to doxyfile. This lets us build documentation in from cmake with the 'doc' target. One difference to the previous version (i.e. the one that was broken before) is that this creates the documentation in the cmake binary directory now instead of the source directory. Reasoning for this is that cmake targets should not change files in the source directory ideally.
@hannes-steffenhagen-diffblue Would you mind adding a test by invoking the target from one of the GitHub actions that use |
@tautschnig how about that? |
b806fd4
to
b480661
Compare
Codecov Report
@@ Coverage Diff @@
## develop #5768 +/- ##
========================================
Coverage 69.65% 69.65%
========================================
Files 1243 1243
Lines 100843 100843
========================================
Hits 70243 70243
Misses 30600 30600
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
- name: Check that doc task works | ||
run: | | ||
cd build | ||
ninja doc |
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.
Nit pick: ninja -C build doc
will do the same in a single line.
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.
Looks good to me
This has been broken for 3 years, ever since doxygen.cfg was renamed to
doxyfile. This lets us build documentation in from cmake with the 'doc'
target. One difference to the previous version (i.e. the one that was
broken before) is that this creates the documentation in the cmake
binary directory now instead of the source directory. Reasoning for this
is that cmake targets should not change files in the source directory
ideally.
Not addressed here: I think this is probably the wrong place to do doxygen stuff anyway, we're referring to files outside this directory which is somewhat unfortunate.