2 # CMake file for OpenCV docs
5 if(BUILD_DOCS AND HAVE_SPHINX)
10 "${OpenCV_SOURCE_DIR}/doc/opencv-logo.png"
11 "${OpenCV_SOURCE_DIR}/doc/opencv-logo2.png"
12 "${OpenCV_SOURCE_DIR}/doc/opencv-logo-white.png"
13 "${OpenCV_SOURCE_DIR}/doc/opencv.ico"
14 "${OpenCV_SOURCE_DIR}/doc/pattern.png"
15 "${OpenCV_SOURCE_DIR}/doc/acircles_pattern.png")
16 if(NOT INSTALL_CREATE_DISTRIB)
17 list(APPEND DOC_LIST "${OpenCV_SOURCE_DIR}/doc/haartraining.htm")
20 set(OPTIONAL_DOC_LIST "")
23 # build lists of modules to be documented
27 foreach(mod ${OPENCV_MODULES_BUILD} ${OPENCV_MODULES_DISABLED_USER} ${OPENCV_MODULES_DISABLED_AUTO} ${OPENCV_MODULES_DISABLED_FORCE})
28 string(REGEX REPLACE "^opencv_" "" mod "${mod}")
29 if("${OPENCV_MODULE_opencv_${mod}_LOCATION}" STREQUAL "${OpenCV_SOURCE_DIR}/modules/${mod}")
30 list(APPEND BASE_MODULES ${mod})
32 list(APPEND EXTRA_MODULES ${mod})
36 set(FIXED_ORDER_MODULES core imgproc imgcodecs videoio highgui video calib3d features2d objdetect ml flann photo stitching)
38 list(REMOVE_ITEM BASE_MODULES ${FIXED_ORDER_MODULES})
40 ocv_list_sort(BASE_MODULES)
41 ocv_list_sort(EXTRA_MODULES)
43 set(BASE_MODULES ${FIXED_ORDER_MODULES} ${BASE_MODULES})
45 # build lists of documentation files and generate table of contents for reference manual
47 set(DOC_FAKE_ROOT "${CMAKE_CURRENT_BINARY_DIR}/fake-root")
48 set(DOC_FAKE_ROOT_FILES "")
50 function(ocv_doc_add_file_to_fake_root source destination)
52 OUTPUT "${DOC_FAKE_ROOT}/${destination}"
53 COMMAND "${CMAKE_COMMAND}" -E copy "${source}" "${DOC_FAKE_ROOT}/${destination}"
55 COMMENT "Copying ${destination} to fake root..."
58 list(APPEND DOC_FAKE_ROOT_FILES "${DOC_FAKE_ROOT}/${destination}")
59 set(DOC_FAKE_ROOT_FILES "${DOC_FAKE_ROOT_FILES}" PARENT_SCOPE)
62 function(ocv_doc_add_to_fake_root source)
64 set(destination "${ARGV1}")
66 file(RELATIVE_PATH destination "${OpenCV_SOURCE_DIR}" "${source}")
69 if(IS_DIRECTORY "${source}")
70 file(GLOB_RECURSE files RELATIVE "${source}" "${source}/*")
72 foreach(file ${files})
73 ocv_doc_add_file_to_fake_root("${source}/${file}" "${destination}/${file}")
76 ocv_doc_add_file_to_fake_root("${source}" "${destination}")
79 set(DOC_FAKE_ROOT_FILES "${DOC_FAKE_ROOT_FILES}" PARENT_SCOPE)
82 set(OPENCV_REFMAN_TOC "")
84 foreach(mod ${BASE_MODULES} ${EXTRA_MODULES})
85 if(EXISTS "${OPENCV_MODULE_opencv_${mod}_LOCATION}/doc/${mod}.rst")
86 ocv_doc_add_to_fake_root("${OPENCV_MODULE_opencv_${mod}_LOCATION}/doc" modules/${mod}/doc)
87 set(OPENCV_REFMAN_TOC "${OPENCV_REFMAN_TOC} ${mod}/doc/${mod}.rst\n")
91 configure_file("${OpenCV_SOURCE_DIR}/modules/refman.rst.in" "${DOC_FAKE_ROOT}/modules/refman.rst" @ONLY)
93 ocv_doc_add_to_fake_root("${OpenCV_SOURCE_DIR}/index.rst")
94 ocv_doc_add_to_fake_root("${OpenCV_SOURCE_DIR}/doc")
95 ocv_doc_add_to_fake_root("${OpenCV_SOURCE_DIR}/platforms/android")
96 ocv_doc_add_to_fake_root("${OpenCV_SOURCE_DIR}/samples")
98 set(BUILD_PLANTUML "")
100 set(BUILD_PLANTUML "-tplantuml")
103 if(PDFLATEX_COMPILER)
104 add_custom_target(docs
105 COMMAND ${SPHINX_BUILD} ${BUILD_PLANTUML} -b latex -c "${CMAKE_CURRENT_SOURCE_DIR}" "${DOC_FAKE_ROOT}" .
106 COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/pics ${CMAKE_CURRENT_BINARY_DIR}/doc/opencv1/pics
107 COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/mymath.sty ${CMAKE_CURRENT_BINARY_DIR}
108 COMMAND ${PYTHON_DEFAULT_EXECUTABLE} "${CMAKE_CURRENT_SOURCE_DIR}/patch_refman_latex.py" opencv2refman.tex
109 COMMAND ${PYTHON_DEFAULT_EXECUTABLE} "${CMAKE_CURRENT_SOURCE_DIR}/patch_refman_latex.py" opencv2manager.tex
110 COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv2refman.pdf"
111 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv2refman.tex
112 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv2refman.tex
113 COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv2manager.pdf"
114 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv2manager.tex
115 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv2manager.tex
116 COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv_user.pdf"
117 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv_user.tex
118 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv_user.tex
119 COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv_tutorials.pdf"
120 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv_tutorials.tex
121 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode opencv_tutorials.tex
122 COMMAND ${CMAKE_COMMAND} -E echo "Generating opencv_cheatsheet.pdf"
123 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode "${CMAKE_CURRENT_SOURCE_DIR}/opencv_cheatsheet.tex"
124 COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode "${CMAKE_CURRENT_SOURCE_DIR}/opencv_cheatsheet.tex"
125 DEPENDS ${DOC_FAKE_ROOT_FILES}
126 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
127 COMMENT "Generating the PDF Manuals"
130 LIST(APPEND OPTIONAL_DOC_LIST "${CMAKE_BINARY_DIR}/doc/opencv2refman.pdf" "${CMAKE_BINARY_DIR}/doc/opencv2manager.pdf"
131 "${CMAKE_BINARY_DIR}/doc/opencv_user.pdf" "${CMAKE_BINARY_DIR}/doc/opencv_tutorials.pdf" "${CMAKE_BINARY_DIR}/doc/opencv_cheatsheet.pdf")
133 if(ENABLE_SOLUTION_FOLDERS)
134 set_target_properties(docs PROPERTIES FOLDER "documentation")
138 add_custom_target(html_docs
139 COMMAND "${SPHINX_BUILD}" ${BUILD_PLANTUML} -b html -c "${CMAKE_CURRENT_SOURCE_DIR}" "${DOC_FAKE_ROOT}" ./_html
140 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/mymath.sty ${CMAKE_CURRENT_BINARY_DIR}
141 DEPENDS ${DOC_FAKE_ROOT_FILES}
142 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
143 COMMENT "Generating Online Documentation"
146 if(ENABLE_SOLUTION_FOLDERS)
147 set_target_properties(html_docs PROPERTIES FOLDER "documentation")
150 foreach(f ${DOC_LIST})
151 install(FILES "${f}" DESTINATION "${OPENCV_DOC_INSTALL_PATH}" COMPONENT docs)
154 foreach(f ${OPTIONAL_DOC_LIST})
155 install(FILES "${f}" DESTINATION "${OPENCV_DOC_INSTALL_PATH}" OPTIONAL COMPONENT docs)