-# 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
SALOME_CONFIGURE_FILE(Doxyfile_med_user.in Doxyfile_med_user)
SALOME_CONFIGURE_FILE(static/header.html.in static/header.html)
-FILE(TO_NATIVE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/medcouplingexamples.in" input)
-FILE(TO_NATIVE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/BuildPyExamplesFromCPP.py" pythondocexamplesgenerator)
-FILE(TO_NATIVE_PATH "${CMAKE_CURRENT_BINARY_DIR}" output)
-
+
+IF(SALOME_MED_ENABLE_PYTHON)
+ INCLUDE(doxy2swig/doxy2swig.cmake)
-# :TRICKY: For ease of maintenance, documentation for code examples is
-# splitted in several files. We here splice to a single file before running
-# Doxygen.
+ 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
+ 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 medcouplingexamples.in "")
-# Call the "concat" function for each example file
-FOREACH(EXAMPLE_FILE ${EXAMPLE_FILES})
- concat(${EXAMPLE_FILE} medcouplingexamples.in)
-ENDFOREACH()
-# Copy the temporary file to the final location
-#CONFIGURE_FILE(medcouplingexamples.in ${CMAKE_CURRENT_BINARY_DIR}/medcouplingexamples.dox)
-# Note: The reason for writing to a temporary is so the real target file only
-# gets updated if its content has changed.
+ # 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}
+ # 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}
)
-INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target usr_docs)")
+ # 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_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES doc_ref_user)
+SET(MAKE_CLEAN_FILES doc_ref_user tmp)
+SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${MAKE_CLEAN_FILES}")