Salome HOME
26aa3f0b56cac1786d58eebebfb964b39e5a3cb3
[tools/documentation.git] / CMakeModules / FindSphinx.cmake
1 # - Sphinx detection
2 #
3 # Output variables:
4 #   SPHINX_EXECUTABLE - path to the Sphinx executable
5 #   SPHINX_PYTHONPATH - path to the Sphinx Python modules                 
6
7 ###########################################################################
8 # Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
9 #
10 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
11 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
12 #
13 # This library is free software; you can redistribute it and/or
14 # modify it under the terms of the GNU Lesser General Public
15 # License as published by the Free Software Foundation; either
16 # version 2.1 of the License, or (at your option) any later version.
17 #
18 # This library is distributed in the hope that it will be useful,
19 # but WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21 # Lesser General Public License for more details.
22 #
23 # You should have received a copy of the GNU Lesser General Public
24 # License along with this library; if not, write to the Free Software
25 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
26 #
27 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
28 #
29
30 FIND_PROGRAM(SPHINX_EXECUTABLE sphinx-build PATH_SUFFIXES Scripts)
31 FIND_PROGRAM(SPHINX_APIDOC_EXECUTABLE sphinx-apidoc PATH_SUFFIXES Scripts)
32
33 # Get root dir locally, going up two levels from the exec:
34 GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${SPHINX_EXECUTABLE}" PATH)
35 GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
36 IF(WIN32)
37   SET(SPHINX_PYTHONPATH "${_tmp_ROOT_DIR}/lib/site-packages")
38 ELSE()
39   SET(SPHINX_PYTHONPATH "${_tmp_ROOT_DIR}/lib/python${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}/site-packages")
40 ENDIF()
41
42 # Handle the standard arguments of the find_package() command:
43 INCLUDE(FindPackageHandleStandardArgs)
44 FIND_PACKAGE_HANDLE_STANDARD_ARGS(Sphinx REQUIRED_VARS SPHINX_EXECUTABLE SPHINX_APIDOC_EXECUTABLE)
45
46 IF(SPHINX_EXECUTABLE)
47   EXECUTE_PROCESS(COMMAND ${SPHINX_EXECUTABLE} "--version" OUTPUT_VARIABLE SPHINX_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE)
48   STRING(REGEX REPLACE ".* ([0-9.]+)$" "\\1" SPHINX_VERSION "${SPHINX_VERSION}" )
49   MESSAGE(STATUS "Sphinx version is ${SPHINX_VERSION}")
50   IF(SPHINX_VERSION VERSION_LESS "1.3")
51     SET(SPHINX_THEME "default")
52   ELSE()
53     SET(SPHINX_THEME "classic")
54   ENDIF()
55 ENDIF(SPHINX_EXECUTABLE)