← Back to branch summary

~widelands-dev/widelands/trunk

« back to all changes in this revision

Viewing changes to cmake/Modules/Documentation.cmake

  • Committer: The Widelands Bunnybot
  • Date: 2021-10-18 08:45:06 UTC
  • Revision ID: bunnybot@widelands.org-20211018084506-d9m4nu72xmxg45km
Build System Update (#5085)

- Silence an undesired naming scheme warning in the SDL2 finding module
- Add a customized copy of CMake's deprecated Documentation module as recommended
- Update latest g++/clang versions in the CI
- Treat enabled compiler warnings as errors
- Allow silencing compile.sh status messages with `-q`

Co-authored-by: Tóth András <txa-dev@posteo.hu>

(by Noordfrees)
f4bd715de44e48af2ef0c283ef877007a2f9bf40

Show diffs side-by-side

added added

removed removed

Lines of Context:
cmake/Modules/Documentation.cmake
 
1
# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
 
2
# file Copyright.txt or https://cmake.org/licensing for details.
 
3
 
 
4
# Modified from the original CMake 3.18 module by the Widelands Development Team.
 
5
 
 
6
#[=======================================================================[.rst:
 
7
Documentation
 
8
-------------
 
9
 
 
10
This module provides support for the VTK documentation framework.  It
 
11
relies on several tools (Doxygen, Perl, etc).
 
12
#]=======================================================================]
 
13
 
 
14
#
 
15
# Build the documentation ?
 
16
#
 
17
option(BUILD_DOCUMENTATION "Build the documentation (Doxygen)." OFF)
 
18
mark_as_advanced(BUILD_DOCUMENTATION)
 
19
 
 
20
if (BUILD_DOCUMENTATION)
 
21
 
 
22
  #
 
23
  # Check for the tools
 
24
  #
 
25
  find_package(UnixCommands)
 
26
  find_package(Doxygen)
 
27
  find_package(Gnuplot)
 
28
  find_package(HTMLHelp)
 
29
  find_package(Perl)
 
30
  find_package(Wget)
 
31
 
 
32
  option(DOCUMENTATION_HTML_HELP
 
33
    "Build the HTML Help file (CHM)." OFF)
 
34
 
 
35
  option(DOCUMENTATION_HTML_TARZ
 
36
    "Build a compressed tar archive of the HTML doc." OFF)
 
37
 
 
38
  mark_as_advanced(
 
39
    DOCUMENTATION_HTML_HELP
 
40
    DOCUMENTATION_HTML_TARZ
 
41
    )
 
42
 
 
43
  #
 
44
  # The documentation process is controlled by a batch file.
 
45
  # We will probably need bash to create the custom target
 
46
  #
 
47
 
 
48
endif (BUILD_DOCUMENTATION)