mirror/opencv
1
0
Fork 0
mirror of https://github.com/opencv/opencv.git synced 2024-11-24 03:00:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
bea86deea9
opencv/doc/CMakeLists.txt

191 lines
7.7 KiB
CMake
Raw Normal View History

Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
#-----------------------
"atomic bomb" commit. Reorganized OpenCV directory structure
2010-05-12 01:44:00 +08:00
# CMake file for OpenCV docs
Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
#-----------------------
"atomic bomb" commit. Reorganized OpenCV directory structure
2010-05-12 01:44:00 +08:00
Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
set(HAVE_DOC_GENERATOR BUILD_DOCS AND (HAVE_SPHINX OR HAVE_DOXYGEN))
"atomic bomb" commit. Reorganized OpenCV directory structure
2010-05-12 01:44:00 +08:00
Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
if(HAVE_DOC_GENERATOR)
cmake scripts are updated to prefer includes from the OpenCV source tree
2012-03-03 23:49:23 +08:00
project(opencv_docs)
Made reference manual table of contents autogenerated
2012-05-30 22:06:47 +08:00
# build lists of modules to be documented
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
set(BASE_MODULES "")
set(EXTRA_MODULES "")
Made reference manual table of contents autogenerated
2012-05-30 22:06:47 +08:00
foreach(mod ${OPENCV_MODULES_BUILD} ${OPENCV_MODULES_DISABLED_USER} ${OPENCV_MODULES_DISABLED_AUTO} ${OPENCV_MODULES_DISABLED_FORCE})
string(REGEX REPLACE "^opencv_" "" mod "${mod}")
if("${OPENCV_MODULE_opencv_${mod}_LOCATION}" STREQUAL "${OpenCV_SOURCE_DIR}/modules/${mod}")
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
list(APPEND BASE_MODULES ${mod})
Made reference manual table of contents autogenerated
2012-05-30 22:06:47 +08:00
else()
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
list(APPEND EXTRA_MODULES ${mod})
Made reference manual table of contents autogenerated
2012-05-30 22:06:47 +08:00
endif()
endforeach()
Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
ocv_list_sort(BASE_MODULES)
ocv_list_sort(EXTRA_MODULES)
moved nonfree and a part of features2d to opencv_contrib/xfeatures2d
2014-08-12 03:26:39 +08:00
set(FIXED_ORDER_MODULES core imgproc imgcodecs videoio highgui video calib3d features2d objdetect ml flann photo stitching)
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
list(REMOVE_ITEM BASE_MODULES ${FIXED_ORDER_MODULES})
Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
set(BASE_MODULES ${FIXED_ORDER_MODULES} ${BASE_MODULES})
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
set(DOC_LIST
"${OpenCV_SOURCE_DIR}/doc/opencv-logo.png"
"${OpenCV_SOURCE_DIR}/doc/opencv-logo2.png"
"${OpenCV_SOURCE_DIR}/doc/opencv-logo-white.png"
"${OpenCV_SOURCE_DIR}/doc/opencv.ico"
"${OpenCV_SOURCE_DIR}/doc/pattern.png"
"${OpenCV_SOURCE_DIR}/doc/acircles_pattern.png")
set(OPTIONAL_DOC_LIST "")
endif(HAVE_DOC_GENERATOR)
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
# ========= Sphinx docs =========
if(BUILD_DOCS AND HAVE_SPHINX)
if(NOT INSTALL_CREATE_DISTRIB)
list(APPEND DOC_LIST "${OpenCV_SOURCE_DIR}/doc/haartraining.htm")
endif()
Made reference manual table of contents autogenerated
2012-05-30 22:06:47 +08:00
# build lists of documentation files and generate table of contents for reference manual
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
set(DOC_FAKE_ROOT "${CMAKE_CURRENT_BINARY_DIR}/fake-root")
set(DOC_FAKE_ROOT_FILES "")
Made reference manual table of contents autogenerated
2012-05-30 22:06:47 +08:00
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
function(ocv_doc_add_file_to_fake_root source destination)
add_custom_command(
OUTPUT "${DOC_FAKE_ROOT}/${destination}"
COMMAND "${CMAKE_COMMAND}" -E copy "${source}" "${DOC_FAKE_ROOT}/${destination}"
DEPENDS "${source}"
COMMENT "Copying ${destination} to fake root..."
VERBATIM
)
list(APPEND DOC_FAKE_ROOT_FILES "${DOC_FAKE_ROOT}/${destination}")
set(DOC_FAKE_ROOT_FILES "${DOC_FAKE_ROOT_FILES}" PARENT_SCOPE)
endfunction()
function(ocv_doc_add_to_fake_root source)
if(ARGC GREATER 1)
set(destination "${ARGV1}")
else()
file(RELATIVE_PATH destination "${OpenCV_SOURCE_DIR}" "${source}")
endif()
if(IS_DIRECTORY "${source}")
file(GLOB_RECURSE files RELATIVE "${source}" "${source}/*")
foreach(file ${files})
ocv_doc_add_file_to_fake_root("${source}/${file}" "${destination}/${file}")
endforeach()
else()
ocv_doc_add_file_to_fake_root("${source}" "${destination}")
Made reference manual table of contents autogenerated
2012-05-30 22:06:47 +08:00
endif()
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
set(DOC_FAKE_ROOT_FILES "${DOC_FAKE_ROOT_FILES}" PARENT_SCOPE)
endfunction()
Build pdf for Android Manager documentation
2012-07-13 21:00:29 +08:00
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
set(OPENCV_REFMAN_TOC "")
foreach(mod ${BASE_MODULES} ${EXTRA_MODULES})
if(EXISTS "${OPENCV_MODULE_opencv_${mod}_LOCATION}/doc/${mod}.rst")
ocv_doc_add_to_fake_root("${OPENCV_MODULE_opencv_${mod}_LOCATION}/doc" modules/${mod}/doc)
set(OPENCV_REFMAN_TOC "${OPENCV_REFMAN_TOC} ${mod}/doc/${mod}.rst\n")
endif()
endforeach()
Made reference manual table of contents autogenerated
2012-05-30 22:06:47 +08:00
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
configure_file("${OpenCV_SOURCE_DIR}/modules/refman.rst.in" "${DOC_FAKE_ROOT}/modules/refman.rst" @ONLY)
cmake scripts are updated to prefer includes from the OpenCV source tree
2012-03-03 23:49:23 +08:00
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
ocv_doc_add_to_fake_root("${OpenCV_SOURCE_DIR}/index.rst")
ocv_doc_add_to_fake_root("${OpenCV_SOURCE_DIR}/doc")
ocv_doc_add_to_fake_root("${OpenCV_SOURCE_DIR}/platforms/android")
ocv_doc_add_to_fake_root("${OpenCV_SOURCE_DIR}/samples")
cmake scripts are updated to prefer includes from the OpenCV source tree
2012-03-03 23:49:23 +08:00
Added plantuml extension Aligned strings in CMakeList Modified the check on plantuml extension Some fixes Moved find_host_program for plantuml script
2013-09-04 22:00:50 +08:00
set(BUILD_PLANTUML "")
if(PLANTUML)
set(BUILD_PLANTUML "-tplantuml")
endif()
cmake scripts are updated to prefer includes from the OpenCV source tree
2012-03-03 23:49:23 +08:00
if(PDFLATEX_COMPILER)
add_custom_target(docs
Merge remote-tracking branch 'origin/2.4' into merge-2.4 Conflicts: .gitignore CMakeLists.txt doc/CMakeLists.txt modules/calib3d/src/stereosgbm.cpp modules/core/include/opencv2/core/mat.hpp modules/highgui/src/cap_openni.cpp modules/ml/include/opencv2/ml/ml.hpp modules/objdetect/src/hog.cpp modules/ocl/perf/perf_color.cpp modules/ocl/src/arithm.cpp modules/ocl/src/filtering.cpp modules/ocl/src/imgproc.cpp modules/ocl/src/optical_flow_farneback.cpp platforms/scripts/camera_build.conf platforms/scripts/cmake_android_all_cameras.py samples/cpp/Qt_sample/main.cpp samples/cpp/tutorial_code/introduction/windows_visual_studio_Opencv/Test.cpp
2013-11-26 19:05:26 +08:00
COMMAND ${SPHINX_BUILD} ${BUILD_PLANTUML} -b latex -c "${CMAKE_CURRENT_SOURCE_DIR}" "${DOC_FAKE_ROOT}" .
cmake scripts are updated to prefer includes from the OpenCV source tree
2012-03-03 23:49:23 +08:00
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/mymath.sty ${CMAKE_CURRENT_BINARY_DIR}
Build both Python 2 and Python 3 bindings If both Python 2 and Python 3 are found, then build bindings for both of them during the build process. Currently, one version of Python is detected automatically, and building for the other requires changes the CMake config. The largest chunk of this change generalizes OpenCVDetectPython.cmake to find both a Python 2 and Python 3 version of Python. Secondly, the opencv_python module is split into two modules, opencv_python2 and opencv_python3. Both are built from the same source. but for different versions of Python.
2014-06-30 04:45:24 +08:00
COMMAND ${PYTHON_DEFAULT_EXECUTABLE} "${CMAKE_CURRENT_SOURCE_DIR}/patch_refman_latex.py" opencv2refman.tex
COMMAND ${PYTHON_DEFAULT_EXECUTABLE} "${CMAKE_CURRENT_SOURCE_DIR}/patch_refman_latex.py" opencv2manager.tex
Add opencv_cheatsheet.pdf to documentation build and silence Latex output
2013-01-18 22:27:43 +08:00
COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv2refman.pdf"
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv2refman.tex
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv2refman.tex
COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv2manager.pdf"
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv2manager.tex
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv2manager.tex
COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv_user.pdf"
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv_user.tex
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv_user.tex
COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv_tutorials.pdf"
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv_tutorials.tex
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv_tutorials.tex
COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv_cheatsheet.pdf"
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode "${CMAKE_CURRENT_SOURCE_DIR}/opencv_cheatsheet.tex"
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode "${CMAKE_CURRENT_SOURCE_DIR}/opencv_cheatsheet.tex"
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
DEPENDS ${DOC_FAKE_ROOT_FILES}
cmake scripts are updated to prefer includes from the OpenCV source tree
2012-03-03 23:49:23 +08:00
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating the PDF Manuals"
)
Installation of documents fixed.
2012-12-08 21:07:55 +08:00
LIST(APPEND OPTIONAL_DOC_LIST "${CMAKE_BINARY_DIR}/doc/opencv2refman.pdf" "${CMAKE_BINARY_DIR}/doc/opencv2manager.pdf"
"${CMAKE_BINARY_DIR}/doc/opencv_user.pdf" "${CMAKE_BINARY_DIR}/doc/opencv_tutorials.pdf" "${CMAKE_BINARY_DIR}/doc/opencv_cheatsheet.pdf")
cmake scripts are updated to prefer includes from the OpenCV source tree
2012-03-03 23:49:23 +08:00
if(ENABLE_SOLUTION_FOLDERS)
set_target_properties(docs PROPERTIES FOLDER "documentation")
endif()
endif()
add_custom_target(html_docs
Merge remote-tracking branch 'origin/2.4' into merge-2.4 Conflicts: .gitignore CMakeLists.txt doc/CMakeLists.txt modules/calib3d/src/stereosgbm.cpp modules/core/include/opencv2/core/mat.hpp modules/highgui/src/cap_openni.cpp modules/ml/include/opencv2/ml/ml.hpp modules/objdetect/src/hog.cpp modules/ocl/perf/perf_color.cpp modules/ocl/src/arithm.cpp modules/ocl/src/filtering.cpp modules/ocl/src/imgproc.cpp modules/ocl/src/optical_flow_farneback.cpp platforms/scripts/camera_build.conf platforms/scripts/cmake_android_all_cameras.py samples/cpp/Qt_sample/main.cpp samples/cpp/tutorial_code/introduction/windows_visual_studio_Opencv/Test.cpp
2013-11-26 19:05:26 +08:00
COMMAND "${SPHINX_BUILD}" ${BUILD_PLANTUML} -b html -c "${CMAKE_CURRENT_SOURCE_DIR}" "${DOC_FAKE_ROOT}" ./_html
cmake scripts are updated to prefer includes from the OpenCV source tree
2012-03-03 23:49:23 +08:00
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/mymath.sty ${CMAKE_CURRENT_BINARY_DIR}
Reworked documentation building to work with extra modules. The main problem with extra modules is that they're located outside of the OpenCV root, while Sphinx requires that all documents are within the documentation root. To circumvent this, we create a "fake root" and copy all documentation (as well as all files that it depends on) there. It's a bit messy, but what can you do. As a bonus, this eliminates the need to generate modules/refman.rst inside the source tree.
2013-11-12 23:38:59 +08:00
DEPENDS ${DOC_FAKE_ROOT_FILES}
cmake scripts are updated to prefer includes from the OpenCV source tree
2012-03-03 23:49:23 +08:00
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating Online Documentation"
)
if(ENABLE_SOLUTION_FOLDERS)
set_target_properties(html_docs PROPERTIES FOLDER "documentation")
endif()
Made reference manual table of contents autogenerated
2012-05-30 22:06:47 +08:00
Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
endif()
# ========= Doxygen docs =========
if(BUILD_DOCS AND HAVE_DOXYGEN)
set(candidates)
set(all_headers)
set(all_images)
list(APPEND candidates ${BASE_MODULES} ${EXTRA_MODULES})
# blacklisted modules
ocv_list_filterout(candidates "^ts$")
# gathering headers
foreach(m ${candidates})
set(all_headers ${all_headers} "${OPENCV_MODULE_opencv_${m}_HEADERS}")
set(docs_dir "${OPENCV_MODULE_opencv_${m}_LOCATION}/doc")
if(EXISTS ${docs_dir})
set(all_images ${all_images} ${docs_dir})
set(all_headers ${all_headers} ${docs_dir})
endif()
endforeach()
# additional config
string(REGEX REPLACE ";" " \\\\\\n" CMAKE_DOXYGEN_INPUT_LIST "${all_headers}")
string(REGEX REPLACE ";" " \\\\\\n" CMAKE_DOXYGEN_IMAGE_PATH "${all_images}")
set(CMAKE_DOXYGEN_INDEX_MD "${CMAKE_SOURCE_DIR}/README.md")
set(CMAKE_DOXYGEN_LAYOUT "${CMAKE_CURRENT_SOURCE_DIR}/DoxygenLayout.xml")
set(CMAKE_DOXYGEN_OUTPUT_PATH "doxygen")
# writing file
set(doxyfile "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile")
configure_file(Doxyfile.in ${doxyfile} @ONLY)
add_custom_target(doxygen
COMMAND ${DOXYGEN_BUILD} ${doxyfile}
DEPENDS ${doxyfile} ${all_headers} ${all_images})
endif()
if(HAVE_DOC_GENERATOR)
# installation
Installation of documents fixed.
2012-12-08 21:07:55 +08:00
foreach(f ${DOC_LIST})
All installed files marked with component names for install customization.
2014-01-17 20:30:31 +08:00
install(FILES "${f}" DESTINATION "${OPENCV_DOC_INSTALL_PATH}" COMPONENT docs)
Installation of documents fixed.
2012-12-08 21:07:55 +08:00
endforeach()
foreach(f ${OPTIONAL_DOC_LIST})
All installed files marked with component names for install customization.
2014-01-17 20:30:31 +08:00
install(FILES "${f}" DESTINATION "${OPENCV_DOC_INSTALL_PATH}" OPTIONAL COMPONENT docs)
Installation of documents fixed.
2012-12-08 21:07:55 +08:00
endforeach()
Basic doxygen documentation support - updated existing Doxyfile.in - added corresponding cmake instructions - added some specific files (layout, icon) - clean existing doxygen warnings
2014-10-09 18:04:00 +08:00
endif(HAVE_DOC_GENERATOR)
Reference in New Issue Copy Permalink