Salome HOME
0472810a575c26a7413c2369b7d79b8bc3dc6c36
[tools/documentation.git] / CMakeLists.txt
1 # Copyright (C) 2012-2021  CEA/DEN, EDF R&D, OPEN CASCADE
2 #
3 # This library is free software; you can redistribute it and/or
4 # modify it under the terms of the GNU Lesser General Public
5 # License as published by the Free Software Foundation; either
6 # version 2.1 of the License, or (at your option) any later version.
7 #
8 # This library is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 # Lesser General Public License for more details.
12 #
13 # You should have received a copy of the GNU Lesser General Public
14 # License along with this library; if not, write to the Free Software
15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 #
17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 #
19
20 CMAKE_MINIMUM_REQUIRED(VERSION 2.8.8 FATAL_ERROR)
21
22 PROJECT(SalomeDOCUMENTATION)
23
24 # Versioning
25 # ==========
26 # Project name, upper case
27 STRING(TOUPPER ${PROJECT_NAME} PROJECT_NAME_UC)
28
29 SET(${PROJECT_NAME_UC}_MAJOR_VERSION 9)
30 SET(${PROJECT_NAME_UC}_MINOR_VERSION 7)
31 SET(${PROJECT_NAME_UC}_PATCH_VERSION 0)
32 SET(${PROJECT_NAME_UC}_VERSION
33   ${${PROJECT_NAME_UC}_MAJOR_VERSION}.${${PROJECT_NAME_UC}_MINOR_VERSION}.${${PROJECT_NAME_UC}_PATCH_VERSION})
34 SET(${PROJECT_NAME_UC}_VERSION_DEV 1)
35
36 # Common CMake macros
37 # ===================
38 SET(CONFIGURATION_ROOT_DIR $ENV{CONFIGURATION_ROOT_DIR} CACHE PATH "Path to the Salome CMake configuration files")
39 IF(EXISTS ${CONFIGURATION_ROOT_DIR})
40   LIST(APPEND CMAKE_MODULE_PATH "${CONFIGURATION_ROOT_DIR}/cmake")
41   INCLUDE(SalomeMacros NO_POLICY_SCOPE)
42 ELSE()
43   MESSAGE(FATAL_ERROR "We absolutely need the Salome CMake configuration files, please define CONFIGURATION_ROOT_DIR !")
44 ENDIF()
45
46 # Platform setup
47 # ==============
48 LIST(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
49 INCLUDE(SalomeSetupPlatform)
50 INCLUDE(SalomeDocumentationMacros)
51 INCLUDE(DocumentationMacros)
52
53 # User options
54 # ============
55 INCLUDE(CMakeDependentOption)
56 OPTION(SALOME_INSTALL_MODULES_DOC "Install documentation of SALOME modules" OFF)
57 CMAKE_DEPENDENT_OPTION(SALOME_CREATE_SYMLINKS "Create symlinks instead of installing docs" OFF
58                        "NOT WIN32;SALOME_INSTALL_MODULES_DOC" OFF)
59
60 # Find prerequisites needed to documentation generation
61 # =====================================================
62 FIND_PACKAGE(SalomePythonInterp)
63 FIND_PACKAGE(SalomePythonLibs)
64 FIND_PACKAGE(SalomeDoxygen)
65 FIND_PACKAGE(SalomeGraphviz)
66 FIND_PACKAGE(SalomeSphinx)
67
68 # Directories
69 # ===========
70 SET(SALOME_INSTALL_DOC share/doc/salome
71     CACHE PATH "Install path: SALOME documentation")
72 SET(SALOME_INSTALL_DOC_MAIN ${SALOME_INSTALL_DOC}
73     CACHE PATH "Install path: main documentation")
74 SET(SALOME_INSTALL_DOC_GUI ${SALOME_INSTALL_DOC}/gui
75     CACHE PATH "Install path: user documentation")
76 SET(SALOME_INSTALL_DOC_TUI ${SALOME_INSTALL_DOC}/tui
77     CACHE PATH "Install path: developer documentation")
78 SET(SALOME_INSTALL_DOC_DEV ${SALOME_INSTALL_DOC}/dev
79     CACHE PATH "Install path: additional developer documentation")
80 SET(SALOME_INSTALL_DOC_EXAMPLES ${SALOME_INSTALL_DOC}/examples
81     CACHE PATH "Install path: examples")
82 SET(SALOME_INSTALL_DOC_EXTRA ${SALOME_INSTALL_DOC}/extra
83     CACHE PATH "Install path: extra documentation")
84
85 MARK_AS_ADVANCED(
86   SALOME_INSTALL_DOC
87   SALOME_INSTALL_DOC_MAIN
88   SALOME_INSTALL_DOC_GUI 
89   SALOME_INSTALL_DOC_TUI
90   SALOME_INSTALL_DOC_DEV
91   SALOME_INSTALL_DOC_EXAMPLES
92   SALOME_INSTALL_DOC_EXTRA
93 )
94
95 # Sources
96 # =======
97 IF(SALOME_INSTALL_MODULES_DOC)
98   ADD_SUBDIRECTORY(main)
99 ELSE()
100   ADD_SUBDIRECTORY(no_main)
101 ENDIF()
102 ADD_SUBDIRECTORY(tui)
103 ADD_SUBDIRECTORY(gui)
104 ADD_SUBDIRECTORY(examples)
105 ADD_SUBDIRECTORY(dev)
106 ADD_SUBDIRECTORY(extra)