Salome HOME
Copyright update 2020
[tools/configuration.git] / cmake / FindSphinx.cmake
index 09d70a1ebbebde5f0814f938b35e73a84f18a3e7..307ee9d34045aa5fee570fc941ce8566a5765554 100644 (file)
@@ -2,13 +2,18 @@
 #
 # Output variables:
 #   SPHINX_EXECUTABLE - path to the Sphinx executable
-#   SPHINX_PYTHONPATH - path to the Sphinx Python modules                 
-# 
-###########################################################################
-# Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
+#   SPHINX_PYTHONPATH - path to the Sphinx Python modules
+#
+# Additional features:
+#   Sphinx_EXTENSIONS - optional variable which can be used to specify
+#                       a list of required Sphinx extensions; not found
+#                       extensions will be reported during the detection
+#                       procedure; by default this variable is empty.
+#                       Example:
+#                           set(Sphinx_EXTENSIONS sphinxcontrib.napoleon)
 #
-# Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+###########################################################################
+# Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -51,13 +56,11 @@ ENDIF()
 INCLUDE(FindPackageHandleStandardArgs)
 FIND_PACKAGE_HANDLE_STANDARD_ARGS(Sphinx REQUIRED_VARS SPHINX_EXECUTABLE SPHINX_APIDOC_EXECUTABLE SPHINX_INTL_EXECUTABLE)
 
-IF(SPHINX_EXECUTABLE)
-  EXECUTE_PROCESS(COMMAND ${SPHINX_EXECUTABLE} "--version" OUTPUT_VARIABLE SPHINX_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE)
-  STRING(REGEX REPLACE ".* ([0-9.]+)$" "\\1" SPHINX_VERSION "${SPHINX_VERSION}" )
-  MESSAGE(STATUS "Sphinx version is ${SPHINX_VERSION}")
-  IF(SPHINX_VERSION VERSION_LESS "1.3")
-    SET(SPHINX_THEME "default")
+FOREACH(_ext ${Sphinx_EXTENSIONS})
+  EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c "import ${_ext}; print('ok')" OUTPUT_VARIABLE _has_ext ERROR_QUIET)
+  IF(_has_ext)
+    MESSAGE(STATUS "Required Sphinx extension '${_ext}' has been found!")
   ELSE()
-    SET(SPHINX_THEME "classic")
+    MESSAGE(WARNING "Required Sphinx extension '${_ext}' is not found!")
   ENDIF()
-ENDIF(SPHINX_EXECUTABLE)
+ENDFOREACH()