salome_adm/cmake_files/FindSalomeSphinx.cmake

   1 # Copyright (C) 2013  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.
   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 # Sphinx detection for Salome
  21 #
  22 #  !! Please read the generic detection procedure in SalomeMacros.cmake !!
  23 #
  24 # The caller of this macro might set SPHINX_PYTHONPATH to provide a path to be added in front
  25 # of the PYTHONPATH with which the sphinx command should be ran.
  26 #
  27 # Note the environment is also overriden in
  28 #     doc/docutils/CMakeLists.txt
  29 # with the creation of a dedicated launcher script.
  30 #
  31
  32 SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS(Sphinx SPHINX_EXECUTABLE 2)
  33
  34 # Also retrieve paths to DOCUTILS and SETUPTOOLS:
  35 SET(SETUPTOOLS_ROOT_DIR "$ENV{SETUPTOOLS_ROOT_DIR}" CACHE PATH "Path to the Setuptools installation")
  36 SET(DOCUTILS_ROOT_DIR "$ENV{DOCUTILS_ROOT_DIR}" CACHE PATH "Path to the Setuptools installation")
  37
  38 # Ensure the command is run with the given PYTHONPATH
  39 IF(WIN32 AND NOT CYGWIN)
  40    MESSAGE(WARNING "Sphinx windows command not re-tested.")
  41    SET(SPHINX_EXECUTABLE ${SPHINX_EXECUTABLE})
  42 ELSE()
  43    SET(SPHINX_EXECUTABLE /usr/bin/env PYTHONPATH="${SPHINX_PYTHONPATH}:$$PYTHONPATH" ${SPHINX_EXECUTABLE})
  44 ENDIF()
  45
  46 MARK_AS_ADVANCED(SPHINX_EXECUTABLE)
  47
  48 IF(SPHINX_FOUND)
  49   SALOME_ACCUMULATE_ENVIRONMENT(PATH ${SPHINX_ROOT_DIR}/bin)
  50   SALOME_ACCUMULATE_ENVIRONMENT(LD_LIBRARY_PATH ${PYTHON_ROOT_DIR}/lib)
  51   SALOME_ACCUMULATE_ENVIRONMENT(PYTHONPATH ${SPHINX_ROOT_DIR}/lib/python${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}/site-packages
  52                                            ${SETUPTOOLS_ROOT_DIR}/lib/python${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}/site-packages
  53                                            ${DOCUTILS_ROOT_DIR}/lib/python${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}/site-packages)
  54 ENDIF()