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

Fix doxygen build #3311

Merged

Conversation

hjmjohnson
Copy link
Member

Using a modern CMake paradigm for building the documentation was the most efficient way to fix a dependency issue related to ITK_WRAP_DOC.

PR Checklist

@github-actions github-actions bot added type:Documentation Documentation improvement or change type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots labels Mar 17, 2022
Copy link
Member

@dzenanz dzenanz left a comment

Choose a reason for hiding this comment

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

Looks good on a glance.

As documented in https://cmake.org/cmake/help/v3.16/module/FindDoxygen.html

A more robust method for generating a documentation target is provided
since cmake version 3.9.
Running doxygen on a single file is not needed
as a core part of ITK.  Remove the script that
needed cmake configure time support and complicated
the configuration process.
As documented in https://cmake.org/cmake/help/v3.16/module/FindDoxygen.html

A more robust method for generating a documentation target is provided
since cmake version 3.9.
Hide unused options when they are not
relevant for a build.
@hjmjohnson
Copy link
Member Author

Failure is unrelated.

The following tests FAILED:
	 64 - vnl_test_hungarian_algorithm (SEGFAULT)
SetCTestConfiguration:BuildDirectory:/home/vsts/work/1/s-buil

@hjmjohnson
Copy link
Member Author

/azp run ITK.Linux

@hjmjohnson hjmjohnson merged commit 1610321 into InsightSoftwareConsortium:master Mar 18, 2022
@hjmjohnson hjmjohnson deleted the fix-doxygen-build branch March 18, 2022 13:39
# -- Only build if 'Documentation' target is requested ALL
WORKING_DIRECTORY ${ITK_BINARY_DIR}/Utilities/Doxygen
# -- Some of the ITK_DOXYGEN_INPUT are directories, USE_STAMP_FILE requires only files be listed
COMMENT "-- Wrapping ITK: Constructing documentation xml structure."
Copy link
Member

Choose a reason for hiding this comment

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

@hjmjohnson Thank you for updating to the modern CMake Doxygen support.

I saw this CMake status/comment and had to check to see if I had wrapping enabled for my build, as I found it confusing.

Also I'm in the process of building the Doxygen with XML, because it appears the location changed.

N-Dekker added a commit to N-Dekker/ITK that referenced this pull request Mar 8, 2024
The use of doxygen.config has been replaced by DoxygenConfig.cmake, with
pull request InsightSoftwareConsortium#3311
commit a96d03f
"COMP: Use modern doxygen_add_docs for BUILD_DOCUMENTAITON",
Hans Johnson, March 18, 2022
N-Dekker added a commit to N-Dekker/ITK that referenced this pull request Mar 12, 2024
nifti2_io.c was removed by:
- pull request InsightSoftwareConsortium#2630
commit 68221fd
"ENH: Prepare for update to NIFTILIB3.0.1", 9 July 2021

The two doxygen.config.in files were removed by:
- pull request InsightSoftwareConsortium#3311
commit a96d03f
"COMP: Use modern doxygen_add_docs command ITK_WRAP_DOCS", 11 March 2022
- pull request InsightSoftwareConsortium#4500
commit 0c5c638
"STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)", 12 March
2024
hjmjohnson pushed a commit that referenced this pull request Mar 23, 2024
nifti2_io.c was removed by:
- pull request #2630
commit 68221fd
"ENH: Prepare for update to NIFTILIB3.0.1", 9 July 2021

The two doxygen.config.in files were removed by:
- pull request #3311
commit a96d03f
"COMP: Use modern doxygen_add_docs command ITK_WRAP_DOCS", 11 March 2022
- pull request #4500
commit 0c5c638
"STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)", 12 March
2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:Documentation Documentation improvement or change type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants