ITKSphinxExamples icon indicating copy to clipboard operation
ITKSphinxExamples copied to clipboard

Add CI for macOS and Windows documentation

Open tbirdso opened this issue 4 years ago • 5 comments

Issue to track PR 218.

Current behavior

CI successfully builds and publishes documentation for Ubuntu 18.04

Desired behavior

CI successfully builds documentation for Windows, Ubuntu, and macOS platforms. Publishes documentation from Ubuntu 18.04 build only.

Outstanding issues

Doxygen build fails:

2021-03-17T12:45:30.9574383Z [554/1581] cmd.exe /C "cd /D D:\a\ITKExamples\build && D:\a_temp-575274851\cmake-3.18.3-win64-x64\bin\cmake.exe -E echo "Finished obtaining Doxygen TAG"" 2021-03-17T12:45:30.9575221Z Finished obtaining Doxygen TAG 2021-03-17T12:45:31.3548291Z [555/1581] Copying sources 2021-03-17T12:45:38.0276877Z [556/1581] Building CXX object src\CMakeFiles\ImageCompareCommand.dir\ImageCompareCommand.cxx.obj 2021-03-17T12:45:38.8736683Z [557/1581] Linking CXX executable bin\ImageCompareCommand.exe 2021-03-17T12:45:40.3933001Z [558/1581] Downloading and unpacking the Doxygen XML 2021-03-17T12:45:40.4024800Z FAILED: ITKDoxygenXML/index.xml 2021-03-17T12:45:40.4035015Z cmd.exe /C "cd /D D:\a\ITKExamples\build && D:\a_temp-575274851\cmake-3.18.3-win64-x64\bin\cmake.exe -DITKDoxygenXML_TEMP_DIR="D:/a/ITKExamples/build/ITKDoxygenXML-TEMP" -P D:/a/ITKExamples/ITKExamples/CMake/DownloadDoxygenXML.cmake && D:\a_temp-575274851\cmake-3.18.3-win64-x64\bin\cmake.exe -E chdir D:/a/ITKExamples/build/ITKDoxygenXML-TEMP D:/a/_temp/-575274851/cmake-3.18.3-win64-x64/bin/cmake.exe -E tar xjf D:/a/ITKExamples/build/ITKDoxygenXML-TEMP/itk-doxygen-xml.tar.bz2 && D:\a_temp-575274851\cmake-3.18.3-win64-x64\bin\cmake.exe -E rename D:/a/ITKExamples/build/ITKDoxygenXML-TEMP/xml D:/a/ITKExamples/build/ITKDoxygenXML && D:\a_temp-575274851\cmake-3.18.3-win64-x64\bin\cmake.exe -E remove_directory D:/a/ITKExamples/build/ITKDoxygenXML-TEMP" 2021-03-17T12:45:40.4044178Z -- [download 0% complete] ... 2021-03-17T12:45:40.5441963Z -- [download 100% complete] 2021-03-17T12:45:40.5507087Z Error renaming from "D:/a/ITKExamples/build/ITKDoxygenXML-TEMP/xml" to "D:/a/ITKExamples/build/ITKDoxygenXML": No error 2021-03-17T12:45:40.5509085Z [559/1581] Building CXX object src\Core\Common\CovariantVectorDotProduct\CMakeFiles\CovariantVectorDotProduct.dir\Code.cxx.obj

tbirdso avatar Mar 17 '21 15:03 tbirdso

Compare with other builds:

  • build-test-cxx (Windows): Does not download ITKDoxygen (not building documentation)
  • build-test-documentation (Ubuntu) on master branch: Succeeds in obtaining DoxygenXML

2021-03-17T12:25:02.7716356Z Finished obtaining Doxygen XML

tbirdso avatar Mar 17 '21 15:03 tbirdso

Seeing new issue in Windows build-test-cxx and build-test-documentation:

2021-03-17T16:18:44.5434765Z Build project 2021-03-17T16:18:44.5436010Z MakeCommand:D:\a_temp-575274851\cmake-3.18.3-win64-x64\bin\cmake.exe --build . --config "Release" 2021-03-17T16:18:44.5437362Z Run command: "D:\a_temp-575274851\cmake-3.18.3-win64-x64\bin\cmake.exe" "--build" "." "--config" "Release" 2021-03-17T16:18:44.5681144Z ninja: error: loading 'build.ninja': The system cannot find the file specified. 2021-03-17T16:18:44.5682351Z 2021-03-17T16:18:44.5682817Z 2021-03-17T16:18:44.5734474Z Command exited with the value: 1 2021-03-17T16:18:44.6744335Z MakeCommand:D:\a_temp-575274851\cmake-3.18.3-win64-x64\bin\cmake.exe --build . --config "Release" 2021-03-17T16:18:44.6745296Z Error(s) when building project 2021-03-17T16:18:44.6745834Z 1 Compiler errors 2021-03-17T16:18:44.6746517Z 1 Compiler warnings

tbirdso avatar Mar 17 '21 16:03 tbirdso

Issue root is actually several lines earlier:

The source directory is currently too long, 40 characters. Please move the Examples source directory to a shorter path.

tbirdso avatar Mar 17 '21 17:03 tbirdso

Error in build-test-documentation (Ubuntu):

2021-03-17T18:48:58.8749003Z [722/1581] Running gitstats 2021-03-17T18:48:58.8750093Z FAILED: CMakeFiles/gitstats 2021-03-17T18:48:58.8753625Z cd /home/runner/work/bld && /home/runner/work/_temp/685782585/cmake-3.18.3-Linux-x86_64/bin/cmake -P /home/runner/work/bld/Utilities/SphinxExtensions/RunGitStats.cmake 2021-03-17T18:48:58.8754896Z CMake Error at Utilities/SphinxExtensions/RunGitStats.cmake:20 (message): 2021-03-17T18:48:58.8755625Z Error running gitstats: 2021-03-17T18:48:58.8755923Z 2021-03-17T18:48:58.8756130Z 2021-03-17T18:49:00.0383820Z [723/1581] Building CXX object src/Core/Common/DuplicateAnImage/CMakeFiles/DuplicateAnImage.dir/Code.cxx.o 2021-03-17T18:49:11.8855171Z [724/1581] Building CXX object src/Filtering/LabelMap/ShapeAttributesForBinaryImage/CMakeFiles/ShapeAttributesForBinaryImage.dir/Code.cxx.o 2021-03-17T18:49:11.8857073Z ninja: build stopped: subcommand failed. 2021-03-17T18:49:11.8860027Z Command exited with the value: 1 2021-03-17T18:49:11.8863834Z MakeCommand:/home/runner/work/_temp/685782585/cmake-3.18.3-Linux-x86_64/bin/cmake --build . --config "Release" 2021-03-17T18:49:11.8864624Z Error(s) when building project 2021-03-17T18:49:11.8865641Z 1 Compiler errors 2021-03-17T18:49:11.8866072Z 1 Compiler warnings

tbirdso avatar Mar 17 '21 18:03 tbirdso

From RunGitStats.cmake.in:

COMMAND ${PYTHON_EXECUTABLE} "@ITKExamples_SOURCE_DIR@/Utilities/SphinxExtensions/gitstats/gitstats" --rst "@ITKExamples_SOURCE_DIR@" "@ITKExamples_BINARY_DIR@/Documentation/gitstats" WORKING_DIRECTORY "@ITKExamples_BINARY_DIR@"

tbirdso avatar Mar 17 '21 18:03 tbirdso