From 36030e88d4d1d8bdabde29d1048a52d0364b5ce2 Mon Sep 17 00:00:00 2001 From: =?utf8?q?C=C3=A9dric=20Aguerre?= Date: Fri, 4 Dec 2015 15:31:13 +0100 Subject: [PATCH] Fix documentation --- doc/tutorial/CMakeLists.txt | 6 ++--- doc/tutorial/conf.py.in | 2 +- doc/user/doxygen/CMakeLists.txt | 4 ++-- doc/user/doxygen/Doxyfile_med_user.in | 6 ++--- doc/user/doxygen/doxfiles/gui.dox | 23 ------------------- doc/user/doxygen/doxfiles/index.dox | 6 ++--- .../reference/distrib/corba-distrib.dox | 9 ++++---- doc/user/doxygen/doxfiles/start/library.dox | 20 ++++++++-------- 8 files changed, 25 insertions(+), 51 deletions(-) delete mode 100644 doc/user/doxygen/doxfiles/gui.dox diff --git a/doc/tutorial/CMakeLists.txt b/doc/tutorial/CMakeLists.txt index 0f61338a9..a598ac28e 100644 --- a/doc/tutorial/CMakeLists.txt +++ b/doc/tutorial/CMakeLists.txt @@ -84,9 +84,9 @@ ADD_CUSTOM_TARGET(tutorial_doc COMMAND ${make_doc}) ADD_DEPENDENCIES(usr_docs tutorial_doc) #INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target tutorial_doc)") -INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ DESTINATION ${MEDCOUPLING_INSTALL_DOC}/gui/MED/tutorial) -INSTALL(DIRECTORY images/ DESTINATION ${MEDCOUPLING_INSTALL_DOC}/gui/MED/tutorial/images) -INSTALL(DIRECTORY data/ DESTINATION ${MEDCOUPLING_INSTALL_DOC}/gui/MED/tutorial/data) +INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ DESTINATION ${MEDCOUPLING_INSTALL_DOC}/tutorial) +INSTALL(DIRECTORY images/ DESTINATION ${MEDCOUPLING_INSTALL_DOC}/tutorial/images) +INSTALL(DIRECTORY data/ DESTINATION ${MEDCOUPLING_INSTALL_DOC}/tutorial/data) SET(make_clean_files html doctrees) SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${make_clean_files}") diff --git a/doc/tutorial/conf.py.in b/doc/tutorial/conf.py.in index 0622ad520..720713374 100644 --- a/doc/tutorial/conf.py.in +++ b/doc/tutorial/conf.py.in @@ -114,7 +114,7 @@ html_theme = 'classic' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/doc/user/doxygen/CMakeLists.txt b/doc/user/doxygen/CMakeLists.txt index 39e6aecb5..2cfbf7bc9 100644 --- a/doc/user/doxygen/CMakeLists.txt +++ b/doc/user/doxygen/CMakeLists.txt @@ -93,8 +93,8 @@ ELSE() 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 ${MEDCOUPLING_INSTALL_DOC}/gui/MED) -INSTALL(FILES images/head.png DESTINATION ${MEDCOUPLING_INSTALL_DOC}/gui/MED) +INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc_ref_user/html/ DESTINATION ${MEDCOUPLING_INSTALL_DOC}) +INSTALL(FILES images/head.png DESTINATION ${MEDCOUPLING_INSTALL_DOC}) SET(MAKE_CLEAN_FILES doc_ref_user tmp) SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${MAKE_CLEAN_FILES}") diff --git a/doc/user/doxygen/Doxyfile_med_user.in b/doc/user/doxygen/Doxyfile_med_user.in index 4d56fe163..db1b3aee4 100644 --- a/doc/user/doxygen/Doxyfile_med_user.in +++ b/doc/user/doxygen/Doxyfile_med_user.in @@ -75,7 +75,6 @@ INPUT = @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/index.dox \ @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/faq.dox \ @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/start \ @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/tutorial.dox \ - @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/gui.dox \ @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference \ @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/arrays \ @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/reference/meshes \ @@ -95,8 +94,7 @@ INPUT = @CMAKE_CURRENT_SOURCE_DIR@/doxfiles/index.dox \ @PROJECT_SOURCE_DIR@/src/INTERP_KERNEL/Bases \ @PROJECT_SOURCE_DIR@/src/INTERP_KERNEL/Geometric2D \ @PROJECT_SOURCE_DIR@/src/MEDCoupling \ - @PROJECT_SOURCE_DIR@/src/MEDLoader \ - @PROJECT_SOURCE_DIR@/src/MEDCouplingCorba + @PROJECT_SOURCE_DIR@/src/MEDLoader FILE_PATTERNS = InterpKernelDEC.* \ OverlapDEC.* \ @@ -283,4 +281,4 @@ DOT_CLEANUP = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine #--------------------------------------------------------------------------- -SEARCHENGINE = NO +SEARCHENGINE = YES diff --git a/doc/user/doxygen/doxfiles/gui.dox b/doc/user/doxygen/doxfiles/gui.dox deleted file mode 100644 index fe63dd880..000000000 --- a/doc/user/doxygen/doxfiles/gui.dox +++ /dev/null @@ -1,23 +0,0 @@ -/*! -\page gui Graphical user interface - -

A graphical interface for standard use cases

- -The MED module in SALOME comes with a graphical interface that helps -you deal with the most standard use cases of field manipulation. The -user guide can be found here: - -- User guide of the MED Graphical Interface - -You could also be interested to read the software specifications and -requirements for this graphical module, and even the technical -considerations for development: - -- Software - specifications and requirements of the MED Graphical Interface (in french) -- Developer guide of the MED Graphical Interface (in french) - -*/ diff --git a/doc/user/doxygen/doxfiles/index.dox b/doc/user/doxygen/doxfiles/index.dox index fd9b49a8e..c18f126f0 100644 --- a/doc/user/doxygen/doxfiles/index.dox +++ b/doc/user/doxygen/doxfiles/index.dox @@ -2,13 +2,12 @@ \mainpage Welcome to MEDCoupling! -The MED module gathers several powerful functionalities around the input and output data of +The MEDCoupling tool gathers several powerful functionalities around the input and output data of simulation codes (meshes and fields mainly). \image html projectionHQ_600.png "Example of a field interpolation between two 3D surfacic meshes" -The most common usage is to write dedicated code (C++ or Python) linking to the library, -however a \ref gui "graphical user interface" is also available. +The most common usage is to write dedicated code (C++ or Python) linking to the library. However a graphical user interface is also available; for this please refer to the MED module documentation. - If you don't know where to start, reading the \ref start "getting started" section and then taking a look at the tutorial is probably a good way to go. @@ -31,7 +30,6 @@ This documentation is organized as follows: - \ref functionalities - \ref python-api - Tutorial - MEDCoupling/MEDLoader in Python -- \ref gui - \ref reference - \ref medcoupling - \ref medloader diff --git a/doc/user/doxygen/doxfiles/reference/distrib/corba-distrib.dox b/doc/user/doxygen/doxfiles/reference/distrib/corba-distrib.dox index 59ed64c2e..cf841cf04 100644 --- a/doc/user/doxygen/doxfiles/reference/distrib/corba-distrib.dox +++ b/doc/user/doxygen/doxfiles/reference/distrib/corba-distrib.dox @@ -1,9 +1,10 @@ /*! \page corba-distrib Distribution in MEDCoupling using CORBA -The following classes allow to publish \ref medcoupling "MEDCoupling objects" on the CORBA bus. They are -directly related to the equivalent class in MEDCoupling, without the string \c Servant at the end of the -name: +The following classes allow to publish \ref medcoupling "MEDCoupling objects" on the CORBA bus. +They are provided in the SALOME MED module that contains elements for the integration of MEDCoupling in SALOME. +They are directly related to the equivalent class in MEDCoupling, without the string \c Servant at the end of the +name: - \ref ParaMEDMEM::DataArrayDoubleServant "DataArrayDoubleServant" - \ref ParaMEDMEM::DataArrayIntServant "DataArrayIntServant" @@ -13,4 +14,4 @@ name: TODO: complete the list. -*/ \ No newline at end of file +*/ diff --git a/doc/user/doxygen/doxfiles/start/library.dox b/doc/user/doxygen/doxfiles/start/library.dox index 921338504..01223ab5d 100644 --- a/doc/user/doxygen/doxfiles/start/library.dox +++ b/doc/user/doxygen/doxfiles/start/library.dox @@ -2,9 +2,9 @@ \page library The MED constellation: MEDCoupling, MEDLoader, MED file, etc ... \section lib-termino Who's who? -The library and the module have evolved over the years, raising +The library and the module have evolved over the years, raising some confusion between all the names used to label the various pieces. This page tries to clarify -this situation. +this situation. "MED" can (unfortunately) refer to: - \ref med-file "MED file format": the file format used to save a mesh (".med" extension) @@ -12,29 +12,29 @@ this situation. with SALOME) to read/write MED file (warning: for advanced users only!) - \ref medcoupling "MEDCoupling": the (relatively) high level API to deal with mesh and fields in memory - \ref medloader MEDLoader: part of the library dedicated to file I/O = a more user-friendly API than the MED-file library API -- \ref remapper "Remapper": part of the library dedicated to +- \ref remapper "Remapper": part of the library dedicated to \ref interpolation "interpolation/projection methods" -- \ref gui "SALOME’s MED module" (GUI point of view): a graphical client in the SALOME main application, providing a graphical interaction with part of the library +- SALOME’s MED module (GUI point of view): a graphical client in the SALOME main application, providing a graphical interaction with part of the library ; for this please refer to the MED module documentation - and finally \ref parallel "ParaMEDMEM", for the projection operations and field transfers in parallel -The most common confusion is between the MED library (what you are reading at present) and -the MED-file library ("MED fichier"). +The most common confusion is between the MED library (what you are reading at present) and +the MED-file library ("MED fichier"). The MED-file library is part of the prerequisites of the MED libary, and its only purpose is to read and write MED files. This is a low level API written in C, and giving a fine-grain access to the structure of the MED files (.med). The architecture diagramm below details those points further. -Another source of common confusion is that all the standard (sequential) MEDCoupling/MEDLoader API lies in +Another source of common confusion is that all the standard (sequential) MEDCoupling/MEDLoader API lies in the \b %ParaMEDMEM namespace. This is quite unfortunate but due to historical reasons. The true parallel functionalities -of the MED library are detailed here: \ref parallel, but are still often called +of the MED library are detailed here: \ref parallel, but are still often called the %ParaMEDMEM part of the library. \section lib-archi Architecture The figure below represents the layer structure of the packages of the -library. +library. - each element depends on the blocks it covers (fully or partially). - White blocks represent system or external dependencies. -- the MEDCalc block, with gray background color, is the \ref gui "Graphical User Interface". +- the MEDCalc block, with gray background color, is the Graphical User Interface (please refer to the MED module documentation). - red-colored text identifies code with Swig interfaces (API available in \ref python-api "Python") - blue-colored text identifies code with both \ref python-api "Swig interfaces" and \ref corba-distrib "CORBA layer". -- 2.30.2