cmake/UseSphinx.cmake

   1 ###########################################################################
   2 # Copyright (C) 2007-2019  CEA/DEN, EDF R&D, OPEN CASCADE
   3 #
   4 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License, or (at your option) any later version.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20 #
  21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 #
  23
  24 include(SalomeMacros)
  25
  26 IF(NOT Sphinx_FOUND)
  27    MESSAGE(FATAL_ERROR "Developer error -> UseSphinx file should be included after detection of the sphinx!")
  28 ENDIF()
  29
  30 function(JOIN OUTPUT GLUE)
  31     set(_TMP_RESULT "")
  32     set(_GLUE "") # effective glue is empty at the beginning
  33     foreach(arg ${ARGN})
  34         set(_TMP_RESULT "${_TMP_RESULT}${_GLUE}${arg}")
  35         set(_GLUE "${GLUE}")
  36     endforeach()
  37     set(${OUTPUT} "${_TMP_RESULT}" PARENT_SCOPE)
  38 endfunction()
  39
  40 #----------------------------------------------------------------------------
  41 # ADD_MULTI_LANG_DOCUMENTATION is a macro which adds sphinx multi-language
  42 # documentation.
  43 #
  44 # USAGE: ADD_MULTI_LANG_DOCUMENTATION(TARGET <target_name> MODULE <module_name>
  45 #                                     LANGUAGES <languages_list>)
  46 #
  47 # ARGUMENTS:
  48 # TARGET_NAME : IN : target name for the documentation
  49 # MODULE : IN : SALOME module name
  50 # LANGUAGES : IN : list of the languages
  51 # ADDITIONAL_ENVIRONMENT: IN : list of additional enviromnent variable used
  52 # for generation of the documentation
  53 #----------------------------------------------------------------------------
  54 MACRO(ADD_MULTI_LANG_DOCUMENTATION)
  55   # Common options
  56   SET(PAPEROPT_a4 "-D latex_paper_size=a4")
  57
  58   # Parse input argument
  59   PARSE_ARGUMENTS(MULTI_LANG "TARGET_NAME;MODULE;LANGUAGES;ADDITIONAL_ENVIRONMENT" "" ${ARGN})
  60
  61   # Content of the executable file to generate documentation
  62   SET(CMDS)
  63
  64   JOIN(SPHINX_EXE " " ${SPHINX_EXECUTABLE})
  65   STRING(REPLACE "$$" "$" SPHINX_EXE ${SPHINX_EXE})
  66
  67   IF(MULTI_LANG_LANGUAGES)
  68     # 1. Options for generation POT files
  69     SET(POT_SPHINXOPTS "-c ${CMAKE_CURRENT_BINARY_DIR} -b gettext ${CMAKE_CURRENT_SOURCE_DIR}/input potfiles")
  70     SET(CMDS "${CMDS} ${SPHINX_EXE} ${POT_SPHINXOPTS}\n")
  71
  72     # 2. Update PO files options
  73     SET(LANGS "")
  74     FOREACH(lang ${MULTI_LANG_LANGUAGES})
  75       SET(LANGS "${LANGS} -l ${lang}")
  76     ENDFOREACH()
  77     SET(PO_SPHINXOPTS "${PO_SPHINXOPTS} update -p potfiles ${LANGS}")
  78     SET(CMDS "${CMDS} ${SPHINX_INTL_EXECUTABLE} ${PO_SPHINXOPTS}\n")
  79
  80     # 3. Build MO files
  81     SET(CMDS "${CMDS} ${SPHINX_INTL_EXECUTABLE} build\n")
  82   ENDIF()
  83
  84   # 4. Options for EN documentation
  85   SET(SPHINXOPTS "-c ${CMAKE_CURRENT_BINARY_DIR} -d doctrees -b html ${PAPEROPT_a4} ${CMAKE_CURRENT_SOURCE_DIR}/input ${MULTI_LANG_MODULE}")
  86   SET(CMDS "${CMDS} ${SPHINX_EXE} ${SPHINXOPTS}\n")
  87
  88   # 5. Options for other documentation
  89   FOREACH(lang ${MULTI_LANG_LANGUAGES})
  90     SET(${lang}_SPHINXOPTS "-c ${CMAKE_CURRENT_BINARY_DIR} -d doctrees -b html ${PAPEROPT_a4} -D language=${lang} ${CMAKE_CURRENT_SOURCE_DIR}/input ${MULTI_LANG_MODULE}_${lang}")
  91     SET(CMDS "${CMDS} ${SPHINX_EXE} ${${lang}_SPHINXOPTS}\n")
  92   ENDFOREACH()
  93
  94   # 6. Create command file
  95   SET(_script_wo "build_doc")
  96   IF(WIN32)
  97     SET(_ext "bat")
  98   ELSE()
  99     SET(_ext "sh")
 100   ENDIF()
 101   SET(_script "${_script_wo}.${_ext}")
 102
 103   SALOME_GENERATE_ENVIRONMENT_SCRIPT(_not_used_output ${_script_wo} "" "" CONTEXT "${MULTI_LANG_TARGET_NAME}" CONTEXT_NAME "DO_GENERATION" ADDITIONAL_VARIABLES ${MULTI_LANG_ADDITIONAL_ENVIRONMENT})
 104
 105   FILE(APPEND ${_script} "${CMDS}")
 106
 107   # 7. Create custom target
 108   ADD_CUSTOM_TARGET(${MULTI_LANG_TARGET_NAME}
 109                     # 1. Copy existing po files
 110                     COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/locale ${CMAKE_CURRENT_BINARY_DIR}/locale
 111                     # 2.  Generate documentation
 112                     COMMAND ${_call_cmd} ${_script}
 113                     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 114                    )
 115
 116   # 8. Update PO files
 117   FOREACH(lang ${MULTI_LANG_LANGUAGES})
 118     FILE(GLOB _pfiles ${CMAKE_CURRENT_BINARY_DIR}/locale/${lang}/LC_MESSAGES/*.po)
 119     ADD_CUSTOM_COMMAND(TARGET ${MULTI_LANG_TARGET_NAME} POST_BUILD
 120       COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_SOURCE_DIR}/locale/${lang}/LC_MESSAGES)
 121     FOREACH(pofile ${_pfiles})
 122       GET_FILENAME_COMPONENT(fn_wo_path ${pofile} NAME)
 123       ADD_CUSTOM_COMMAND(TARGET ${MULTI_LANG_TARGET_NAME} POST_BUILD
 124                          COMMAND ${CMAKE_COMMAND} -E
 125                          copy_if_different ${pofile} ${CMAKE_CURRENT_SOURCE_DIR}/locale/${lang}/LC_MESSAGES/${fn_wo_path})
 126     ENDFOREACH()
 127   ENDFOREACH()
 128
 129   # 9. Make clean files/folders
 130   SET(make_clean_files ${MULTI_LANG_MODULE} doctrees potfiles locale)
 131   FOREACH(lang ${MULTI_LANG_LANGUAGES})
 132     SET(make_clean_files ${make_clean_files} ${MULTI_LANG_MODULE}_${lang})
 133   ENDFOREACH()
 134   SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${make_clean_files}")
 135
 136 ENDMACRO(ADD_MULTI_LANG_DOCUMENTATION)