Documentation.cmake 1.15 KB
Newer Older
1 2 3
# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.

4 5 6 7
#[=======================================================================[.rst:
Documentation
-------------

8
This module provides support for the VTK documentation framework.  It
9 10
relies on several tools (Doxygen, Perl, etc).
#]=======================================================================]
11 12 13 14

#
# Build the documentation ?
#
15 16
option(BUILD_DOCUMENTATION "Build the documentation (Doxygen)." OFF)
mark_as_advanced(BUILD_DOCUMENTATION)
17

18
if (BUILD_DOCUMENTATION)
19 20 21 22

  #
  # Check for the tools
  #
23 24 25 26 27 28 29 30
  find_package(UnixCommands)
  find_package(Doxygen)
  find_package(Gnuplot)
  find_package(HTMLHelp)
  find_package(Perl)
  find_package(Wget)

  option(DOCUMENTATION_HTML_HELP
31
    "Build the HTML Help file (CHM)." OFF)
32

33
  option(DOCUMENTATION_HTML_TARZ
34
    "Build a compressed tar archive of the HTML doc." OFF)
35

36
  mark_as_advanced(
37 38
    DOCUMENTATION_HTML_HELP
    DOCUMENTATION_HTML_TARZ
39
    )
40

41
  #
luz.paz's avatar
luz.paz committed
42
  # The documentation process is controlled by a batch file.
43 44 45
  # We will probably need bash to create the custom target
  #

46
endif ()