CMake/Modules/Documentation.cmake

58 lines
1.5 KiB
CMake
Raw Normal View History

#.rst:
# Documentation
# -------------
#
# DocumentationVTK.cmake
#
# This file provides support for the VTK documentation framework. It
# relies on several tools (Doxygen, Perl, etc).
2001-10-26 19:22:09 +04:00
#=============================================================================
# Copyright 2001-2009 Kitware, Inc.
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
# License text for the above reference.)
2001-10-26 19:22:09 +04:00
#
# Build the documentation ?
#
option(BUILD_DOCUMENTATION "Build the documentation (Doxygen)." OFF)
mark_as_advanced(BUILD_DOCUMENTATION)
2001-10-26 19:22:09 +04:00
if (BUILD_DOCUMENTATION)
2001-10-26 19:22:09 +04:00
#
# 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)
2001-10-26 19:22:09 +04:00
option(DOCUMENTATION_HTML_TARZ
"Build a compressed tar archive of the HTML doc." OFF)
2001-10-26 19:22:09 +04:00
mark_as_advanced(
DOCUMENTATION_HTML_HELP
DOCUMENTATION_HTML_TARZ
)
#
2001-10-26 19:22:09 +04:00
# The documentation process is controled by a batch file.
# We will probably need bash to create the custom target
#
endif ()