Merge pull request #4643 from sloriot/CGAL-no_Three_doc

Three doc should not be built by default in public releases
This commit is contained in:
Sebastien Loriot 2020-04-22 13:00:43 +02:00 committed by GitHub
commit b5388c624a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 11 additions and 5 deletions

View File

@ -11,7 +11,7 @@ function mytime {
function build_examples { function build_examples {
mkdir -p build-travis mkdir -p build-travis
cd build-travis cd build-travis
mytime cmake -DCGAL_DIR="/usr/local/lib/cmake/CGAL" -DCMAKE_CXX_FLAGS="${CXX_FLAGS}" .. mytime cmake -DCGAL_DIR="/usr/local/lib/cmake/CGAL" -DCMAKE_CXX_FLAGS="${CXX_FLAGS}" -DCGAL_BUILD_THREE_DOC=TRUE ..
mytime make -j2 VERBOSE=1 mytime make -j2 VERBOSE=1
} }
@ -96,7 +96,7 @@ cd $ROOT
cd $ROOT cd $ROOT
mkdir build_test mkdir build_test
cd build_test cd build_test
mytime cmake -DCMAKE_INSTALL_PREFIX=install/ .. mytime cmake -DCMAKE_INSTALL_PREFIX=install/ -DCGAL_BUILD_THREE_DOC=TRUE ..
mytime make install mytime make install
# test install with minimal downstream example # test install with minimal downstream example
mkdir installtest mkdir installtest
@ -110,7 +110,7 @@ cd $ROOT
echo 'target_link_libraries(${PROJECT_NAME} CGAL::CGAL)' >> CMakeLists.txt echo 'target_link_libraries(${PROJECT_NAME} CGAL::CGAL)' >> CMakeLists.txt
echo '#include "CGAL/remove_outliers.h"' >> main.cpp echo '#include "CGAL/remove_outliers.h"' >> main.cpp
cd build cd build
mytime cmake -DCMAKE_INSTALL_PREFIX=../../install .. mytime cmake -DCMAKE_INSTALL_PREFIX=../../install -DCGAL_BUILD_THREE_DOC=TRUE ..
cd .. cd ..
exit 0 exit 0
fi fi

View File

@ -339,6 +339,12 @@ else()
endforeach() endforeach()
endif() endif()
option(CGAL_BUILD_THREE_DOC "Build the documentation of the Three package" OFF)
if (NOT CGAL_BUILD_THREE_DOC)
list(REMOVE_ITEM CGAL_DOC_PACKAGES "Three")
endif()
foreach(package ${CGAL_DOC_PACKAGES}) foreach(package ${CGAL_DOC_PACKAGES})
configure_doxygen_package(${package}) configure_doxygen_package(${package})
endforeach() endforeach()

View File

@ -1183,7 +1183,7 @@ You must disable CGAL_ENABLE_CHECK_HEADERS.")
# Build the doc # Build the doc
set(DOC_DIR "${CMAKE_BINARY_DIR}/build_doc") set(DOC_DIR "${CMAKE_BINARY_DIR}/build_doc")
file(MAKE_DIRECTORY "${DOC_DIR}") file(MAKE_DIRECTORY "${DOC_DIR}")
execute_process(COMMAND "${CMAKE_COMMAND}" -DDOXYGEN_EXECUTABLE=${DOXYGEN_EXECUTABLE} "${CMAKE_SOURCE_DIR}/Documentation/doc" execute_process(COMMAND "${CMAKE_COMMAND}" -DCGAL_BUILD_THREE_DOC=TRUE -DDOXYGEN_EXECUTABLE=${DOXYGEN_EXECUTABLE} "${CMAKE_SOURCE_DIR}/Documentation/doc"
WORKING_DIRECTORY "${DOC_DIR}" WORKING_DIRECTORY "${DOC_DIR}"
) )
execute_process(COMMAND "${CMAKE_COMMAND}" --build . --target "doc" execute_process(COMMAND "${CMAKE_COMMAND}" --build . --target "doc"

View File

@ -30,7 +30,7 @@ do
fi fi
done done
cmake -DCGAL_HEADER_ONLY=FALSE -DCGAL_ENABLE_CHECK_HEADERS=TRUE -DDOXYGEN_EXECUTABLE="$DOX_PATH" -DCGAL_COPY_DEPENDENCIES=TRUE -DCMAKE_CXX_FLAGS="-std=c++11" .. cmake -DCGAL_HEADER_ONLY=FALSE -DCGAL_BUILD_THREE_DOC=TRUE -DCGAL_ENABLE_CHECK_HEADERS=TRUE -DDOXYGEN_EXECUTABLE="$DOX_PATH" -DCGAL_COPY_DEPENDENCIES=TRUE -DCMAKE_CXX_FLAGS="-std=c++11" ..
if [ -n "$DO_CHECK_HEADERS" ]; then if [ -n "$DO_CHECK_HEADERS" ]; then
make -j$(nproc --all) -k check_headers make -j$(nproc --all) -k check_headers
fi fi