Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in / Register
Toggle navigation
O
opencv
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Packages
Packages
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
submodule
opencv
Commits
bf27889f
Commit
bf27889f
authored
May 30, 2012
by
Andrey Kamaev
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Made reference manual table of contents autogenerated
parent
17d9509e
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
48 additions
and
27 deletions
+48
-27
CMakeLists.txt
doc/CMakeLists.txt
+39
-3
refman.rst
modules/refman.rst
+0
-24
refman.rst.in
modules/refman.rst.in
+9
-0
No files found.
doc/CMakeLists.txt
View file @
bf27889f
...
...
@@ -11,8 +11,44 @@ if(BUILD_DOCS AND HAVE_SPHINX)
project
(
opencv_docs
)
file
(
GLOB_RECURSE OPENCV_FILES_REF ../modules/*.rst
)
file
(
GLOB_RECURSE OPENCV_FILES_REF_PICT ../modules/*.png ../modules/*.jpg
)
set
(
OPENCV2_BASE_MODULES core imgproc highgui video calib3d features2d objdetect ml flann gpu photo stitching nonfree contrib legacy
)
# build lists of modules to be documented
set
(
OPENCV2_MODULES
""
)
set
(
OPENCV_MODULES
""
)
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
}
"
)
list
(
APPEND OPENCV2_MODULES
${
mod
}
)
else
()
list
(
APPEND OPENCV_MODULES
${
mod
}
)
endif
()
endforeach
()
list
(
REMOVE_ITEM OPENCV2_MODULES
${
OPENCV2_BASE_MODULES
}
)
ocv_list_sort
(
OPENCV2_MODULES
)
ocv_list_sort
(
OPENCV_MODULES
)
# build lists of documentation files and generate table of contents for reference manual
set
(
OPENCV_FILES_REF
""
)
set
(
OPENCV_FILES_REF_PICT
""
)
set
(
OPENCV_REFMAN_TOC
""
)
foreach
(
mod
${
OPENCV2_BASE_MODULES
}
${
OPENCV2_MODULES
}
${
OPENCV_MODULES
}
)
file
(
GLOB_RECURSE _OPENCV_FILES_REF
"
${
OPENCV_MODULE_opencv_
${
mod
}
_LOCATION
}
/doc/*.rst"
)
file
(
GLOB_RECURSE _OPENCV_FILES_REF_PICT
"
${
OPENCV_MODULE_opencv_
${
mod
}
_LOCATION
}
/doc/*.png"
"
${
OPENCV_MODULE_opencv_
${
mod
}
_LOCATION
}
/doc/*.jpg"
)
list
(
APPEND OPENCV_FILES_REF
${
_OPENCV_FILES_REF
}
)
list
(
APPEND OPENCV_FILES_REF_PICT
${
_OPENCV_FILES_REF_PICT
}
)
set
(
toc_file
"
${
OPENCV_MODULE_opencv_
${
mod
}
_LOCATION
}
/doc/
${
mod
}
.rst"
)
if
(
EXISTS
"
${
toc_file
}
"
)
file
(
RELATIVE_PATH toc_file
"
${
OpenCV_SOURCE_DIR
}
/modules"
"
${
toc_file
}
"
)
set
(
OPENCV_REFMAN_TOC
"
${
OPENCV_REFMAN_TOC
}
${
toc_file
}
\r\n
"
)
endif
()
endforeach
()
configure_file
(
"
${
OpenCV_SOURCE_DIR
}
/modules/refman.rst.in"
"
${
OpenCV_SOURCE_DIR
}
/modules/refman.rst"
IMMEDIATE @ONLY
)
file
(
GLOB_RECURSE OPENCV_FILES_UG user_guide/*.rst
)
file
(
GLOB_RECURSE OPENCV_FILES_TUT tutorials/*.rst
)
file
(
GLOB_RECURSE OPENCV_FILES_TUT_PICT tutorials/*.png tutorials/*.jpg
)
...
...
@@ -54,6 +90,6 @@ if(BUILD_DOCS AND HAVE_SPHINX)
set_target_properties
(
html_docs PROPERTIES FOLDER
"documentation"
)
endif
()
endif
()
install
(
FILES
${
FILES_DOC
}
DESTINATION
"
${
OPENCV_DOC_INSTALL_PATH
}
"
COMPONENT main
)
install
(
FILES
${
FILES_DOC_VS
}
DESTINATION
"
${
OPENCV_DOC_INSTALL_PATH
}
/vidsurv"
COMPONENT main
)
modules/refman.rst
deleted
100644 → 0
View file @
17d9509e
############################
OpenCV API Reference
############################
.. toctree::
:maxdepth: 2
core/doc/intro.rst
core/doc/core.rst
imgproc/doc/imgproc.rst
highgui/doc/highgui.rst
video/doc/video.rst
calib3d/doc/calib3d.rst
features2d/doc/features2d.rst
objdetect/doc/objdetect.rst
ml/doc/ml.rst
flann/doc/flann.rst
gpu/doc/gpu.rst
photo/doc/photo.rst
stitching/doc/stitching.rst
nonfree/doc/nonfree.rst
contrib/doc/contrib.rst
legacy/doc/legacy.rst
modules/refman.rst.in
0 → 100644
View file @
bf27889f
############################
OpenCV API Reference
############################
.. toctree::
:maxdepth: 2
core/doc/intro.rst
@OPENCV_REFMAN_TOC@
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment