Build docs in CI, and rename DOCS CMake config variable to BUILD_DOCS #1339
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
to cary-ilm/openexr
that referenced
this pull request
Feb 22, 2023
* Together with building the docs in the CI (AcademySoftwareFoundation#1339) this means that issues with the documentation will cause the CI checks to fail * All doxygen-annotated class/function comments must now be warning-free. This PR fixes a warning in openexr_context.h by adding missing parameter descriptions. Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
to cary-ilm/openexr
that referenced
this pull request
Feb 23, 2023
* Together with building the docs in the CI (AcademySoftwareFoundation#1339) this means that issues with the documentation will cause the CI checks to fail * All doxygen-annotated class/function comments must now be warning-free. This PR fixes a warning in openexr_context.h by adding missing parameter descriptions. Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
that referenced
this pull request
Feb 27, 2023
* Together with building the docs in the CI (#1339) this means that issues with the documentation will cause the CI checks to fail * All doxygen-annotated class/function comments must now be warning-free. This PR fixes a warning in openexr_context.h by adding missing parameter descriptions. Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
to cary-ilm/openexr
that referenced
this pull request
Mar 3, 2023
…AcademySoftwareFoundation#1339) * Add docs to CI Signed-off-by: Cary Phillips <cary@ilm.com> * yum scripts Signed-off-by: Cary Phillips <cary@ilm.com> --------- Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
to cary-ilm/openexr
that referenced
this pull request
Mar 3, 2023
…reFoundation#1344) * Together with building the docs in the CI (AcademySoftwareFoundation#1339) this means that issues with the documentation will cause the CI checks to fail * All doxygen-annotated class/function comments must now be warning-free. This PR fixes a warning in openexr_context.h by adding missing parameter descriptions. Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
that referenced
this pull request
Mar 5, 2023
…#1339) * Add docs to CI Signed-off-by: Cary Phillips <cary@ilm.com> * yum scripts Signed-off-by: Cary Phillips <cary@ilm.com> --------- Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
that referenced
this pull request
Mar 5, 2023
* Together with building the docs in the CI (#1339) this means that issues with the documentation will cause the CI checks to fail * All doxygen-annotated class/function comments must now be warning-free. This PR fixes a warning in openexr_context.h by adding missing parameter descriptions. Signed-off-by: Cary Phillips <cary@ilm.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
"DOCS" is confusingly brief as a CMake variable, so this renames it to BUILD_DOCS, which appears to be used in other projects.
The CI now builds the docs, although it also appears that a lot can go wrong without the build actually failing, so some further validation that the resulting docs were properly generated would be helpful.