Salome HOME
fix conflict: ctest requires SUBDIRS, not ADD_SUBDIRECTORY directives
[tools/medcoupling.git] / doc / doxygen / CMakeLists.txt
index 47161b504495facfff287d76c7555e8cb80e923d..99392afa3e936a32811ab16b89bcad731527a5db 100644 (file)
@@ -1,9 +1,9 @@
-# Copyright (C) 2012-2013  CEA/DEN, EDF R&D
+# Copyright (C) 2012-2015  CEA/DEN, EDF R&D
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
 # License as published by the Free Software Foundation; either
-# version 2.1 of the License.
+# version 2.1 of the License, or (at your option) any later version.
 #
 # This library is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 #
 
-SET(top_builddir ${CMAKE_BINARY_DIR})
-SET(top_srcdir ${CMAKE_SOURCE_DIR})
-SET(srcdir ${CMAKE_CURRENT_SOURCE_DIR})
-SET(builddir ${CMAKE_CURRENT_BINARY_DIR})
-SET(datadir ${CMAKE_INSTALL_PREFIX}/share)
-SET(docdir ${datadir}/doc/salome)
-
-SET(indoxfiles Doxyfile_med_user.in static/header.html.in)
-FOREACH(indoxfile ${indoxfiles})
-  STRING(REGEX REPLACE ".in" "" baseindoxfile ${indoxfile})
-  SET(input ${CMAKE_CURRENT_SOURCE_DIR}/${indoxfile})
-  SET(output ${CMAKE_CURRENT_BINARY_DIR}/${baseindoxfile})
-  CONFIGURE_FILE(${input} ${output})
-  MESSAGE(STATUS "Creation of ${output}")
-ENDFOREACH(indoxfile ${indoxfiles})
-FILE(TO_NATIVE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/medcouplingexamples.doxy" input)
-FILE(TO_NATIVE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/BuildPyExamplesFromCPP.py" pythondocexamplesgenerator)
-FILE(TO_NATIVE_PATH "${CMAKE_CURRENT_BINARY_DIR}" output)
-
-ADD_CUSTOM_TARGET(usr_docs
-  COMMAND ${PYTHON_EXECUTABLE} ${pythondocexamplesgenerator} ${input} ${output}
-  COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile_med_user
-  COMMAND ${PYTHON_EXECUTABLE} -c "import shutil, sys; shutil.rmtree(r'''${CMAKE_INSTALL_PREFIX}/share/doc/salome/gui/MED''', True); shutil.copytree(r'''${CMAKE_CURRENT_BINARY_DIR}/doc_ref_user/html''', r'''${CMAKE_INSTALL_PREFIX}/share/doc/salome/gui/MED'''); shutil.copy(r'''${CMAKE_CURRENT_SOURCE_DIR}/images/head.png''', r'''${CMAKE_INSTALL_PREFIX}/share/doc/salome/gui/MED''')"
-  VERBATIM 
-  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}             
+SALOME_CONFIGURE_FILE(Doxyfile_med_user.in Doxyfile_med_user)
+SALOME_CONFIGURE_FILE(static/header.html.in static/header.html)
+
+  
+IF(SALOME_MED_ENABLE_PYTHON)
+  INCLUDE(doxy2swig/doxy2swig.cmake)
+
+  FILE(TO_NATIVE_PATH "${CMAKE_CURRENT_BINARY_DIR}/tmp/medcouplingexamples.in" input)
+  FILE(TO_NATIVE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/BuildPyExamplesFromCPP.py" pythondocexamplesgenerator)
+  FILE(TO_NATIVE_PATH "${CMAKE_CURRENT_BINARY_DIR}" output)
+  
+  # :TRICKY: For ease of maintenance, documentation for code examples is
+  # splitted in several files. We here splice to a single file before running
+  # Doxygen.
+
+  SET(EXAMPLE_FILES # files to concatenate: order is important!
+    doxfiles/examples/medcouplingexamplesheader.doxy
+    doxfiles/examples/medcouplingexamplesfields.doxy
+    doxfiles/examples/medcouplingexamplesmeshes.doxy
+    doxfiles/examples/medcouplingexamplesarrays.doxy
+    doxfiles/examples/medcouplingexamplesother.doxy
+    doxfiles/examples/medcouplingexamplesfooter.doxy
   )
+
+  # This function adds IN_FILE contents to the end of OUT_FILE
+  FUNCTION(concat IN_FILE OUT_FILE)
+    FILE(READ ${IN_FILE} CONTENTS)
+    FILE(APPEND ${OUT_FILE} ${CONTENTS})
+  ENDFUNCTION()
+
+  # Prepare a temporary file to "concat" to:
+  FILE(WRITE ${input} "")
+  # Call the "concat" function for each example file
+  FOREACH(EXAMPLE_FILE ${EXAMPLE_FILES})
+    concat(${EXAMPLE_FILE} ${input})
+  ENDFOREACH()
+  # Note: The reason for writing to a temporary is so the real target file only
+  # gets updated if its content has changed.
+
+  # Here is the "standard" procedure, as if ${input} was hand-written.
+  ADD_CUSTOM_TARGET(usr_docs ALL
+    COMMAND ${PYTHON_EXECUTABLE} ${pythondocexamplesgenerator} ${input} ${output}
+    COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile_med_user
+    VERBATIM
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+  )
+  
+  # Create dummy target gathering the generation of all .i files:
+  ADD_CUSTOM_TARGET(swig_ready)
+  ADD_DEPENDENCIES(swig_ready usr_docs)
+  
+  SALOME_MED_SWIG_DOCSTRING_CONFIGURE(usr_docs swig_ready MEDCoupling)
+  SALOME_MED_SWIG_DOCSTRING_CONFIGURE(usr_docs swig_ready MEDLoader)
+    
+  SET(doxyfile_med_user ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile_med_user)
+  FILE(STRINGS ${doxyfile_med_user} enabled_sections REGEX "ENABLED_SECTIONS")
+  IF(enabled_sections)
+    FILE(READ ${doxyfile_med_user} doxy_file)
+    STRING(REPLACE ${enabled_sections} "${enabled_sections} ENABLE_EXAMPLES" new_doxy_file ${doxy_file})
+    FILE(WRITE ${doxyfile_med_user} ${new_doxy_file})
+  ELSE()
+    FILE(APPEND ${doxyfile_med_user} 
+      "#Temporary variable to enable python documentation sections\nENABLED_SECTIONS = ENABLE_EXAMPLES")
+  ENDIF()
+  
+  # Swig generation to have docstrings correctly populated:
+  INCLUDE(doxy2swig/doxy2swig.cmake)
+  
+ELSE()
+  ADD_CUSTOM_TARGET(usr_docs ALL
+    COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile_med_user
+    VERBATIM
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+  )
+ENDIF()
+#INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target usr_docs)")
+INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc_ref_user/html/ DESTINATION ${SALOME_INSTALL_DOC}/gui/MED)
+INSTALL(FILES images/head.png DESTINATION ${SALOME_INSTALL_DOC}/gui/MED) 
+
+SET(MAKE_CLEAN_FILES doc_ref_user tmp)
+SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${MAKE_CLEAN_FILES}")