1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file LICENSE.rst or https://cmake.org/licensing for details.
#[=======================================================================[.rst:
Documentation
-------------
.. deprecated:: 3.18
This module does nothing, unless policy :policy:`CMP0106` is set to ``OLD``.
This module provides support for the VTK documentation framework. It
relies on several tools (Doxygen, Perl, etc).
#]=======================================================================]
cmake_policy(GET CMP0106 _Documentation_policy)
if (_Documentation_policy STREQUAL "NEW")
message(FATAL_ERROR
"Documentation.cmake is VTK-specific code and should not be used in "
"non-VTK projects. This logic in this module is best shipped with the "
"project using it rather than with CMake. This is now an error according "
"to policy CMP0106.")
else ()
if (_Documentation_policy STREQUAL "")
# Ignore the warning if the project is detected as VTK itself.
if (NOT CMAKE_PROJECT_NAME STREQUAL "VTK" AND
NOT PROJECT_NAME STREQUAL "VTK")
cmake_policy(GET_WARNING CMP0106 _Documentation_policy_warning)
message(AUTHOR_WARNING
"${_Documentation_policy_warning}\n"
"Documentation.cmake is VTK-specific code and should not be used in "
"non-VTK projects. This logic in this module is best shipped with the "
"project using it rather than with CMake.")
endif ()
unset(_Documentation_policy_warning)
endif ()
#
# Build the documentation ?
#
option(BUILD_DOCUMENTATION "Build the documentation (Doxygen)." OFF)
mark_as_advanced(BUILD_DOCUMENTATION)
if (BUILD_DOCUMENTATION)
#
# Check for the tools
#
find_package(UnixCommands)
find_package(Doxygen)
find_package(Gnuplot)
find_package(HTMLHelp)
find_package(Perl)
find_package(Wget)
option(DOCUMENTATION_HTML_HELP
"Build the HTML Help file (CHM)." OFF)
option(DOCUMENTATION_HTML_TARZ
"Build a compressed tar archive of the HTML doc." OFF)
mark_as_advanced(
DOCUMENTATION_HTML_HELP
DOCUMENTATION_HTML_TARZ
)
#
# The documentation process is controlled by a batch file.
# We will probably need bash to create the custom target
#
endif ()
endif ()
unset(_Documentation_policy)
|
