From: vsr Date: Thu, 5 Nov 2020 16:03:30 +0000 (+0300) Subject: Install documentation from SALOME modules X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=c7dcd40bb8d0fbde7952637fc4cd239be676fad0;p=tools%2Fdocumentation.git Install documentation from SALOME modules --- diff --git a/BLSURFPLUGIN_index.html b/BLSURFPLUGIN_index.html deleted file mode 100644 index e3d6428..0000000 --- a/BLSURFPLUGIN_index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - MG-CADSurf Meshing Plug-in Documentation - - -

- -

MG-CADSurf Meshing Plug-in Documentation

- -

-

-User's Guide -

-Developer Documentation -

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/CMakeLists.txt b/CMakeLists.txt index ca90d83..b3c6f00 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -16,13 +16,13 @@ # # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # + CMAKE_MINIMUM_REQUIRED(VERSION 2.8.8 FATAL_ERROR) -INCLUDE(CMakeDependentOption) PROJECT(SalomeDOCUMENTATION) # Versioning -# ======== +# ========== # Project name, upper case STRING(TOUPPER ${PROJECT_NAME} PROJECT_NAME_UC) @@ -43,10 +43,22 @@ ELSE() MESSAGE(FATAL_ERROR "We absolutely need the Salome CMake configuration files, please define CONFIGURATION_ROOT_DIR !") ENDIF() +# Platform setup +# ============== +LIST(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake) INCLUDE(SalomeSetupPlatform) +INCLUDE(SalomeDocumentationMacros) +INCLUDE(DocumentationMacros) + +# User options +# ============ +INCLUDE(CMakeDependentOption) +OPTION(SALOME_INSTALL_MODULES_DOC "Install documentation of SALOME modules" OFF) +CMAKE_DEPENDENT_OPTION(SALOME_CREATE_SYMLINKS "Create symlinks instead of installing docs" OFF + "NOT WIN32;SALOME_INSTALL_MODULES_DOC" OFF) # Find prerequisites needed to documentation generation -# ================================================== +# ===================================================== FIND_PACKAGE(SalomePythonInterp) FIND_PACKAGE(SalomePythonLibs) FIND_PACKAGE(SalomeDoxygen) @@ -54,29 +66,41 @@ FIND_PACKAGE(SalomeGraphviz) FIND_PACKAGE(SalomeSphinx) # Directories -# ========= -SET(SALOME_INSTALL_DOC_GUI gui CACHE PATH "Install path: user documentation") -SET(SALOME_INSTALL_DOC_TUI tui CACHE PATH "Install path: developer documentation") -SET(SALOME_INSTALL_DOC_DEV dev CACHE PATH "Install path: additional developer documentation") -SET(SALOME_INSTALL_DOC_EXTRA extra CACHE PATH "Install path: extra documentation") +# =========== +SET(SALOME_INSTALL_DOC share/doc/salome + CACHE PATH "Install path: SALOME documentation") +SET(SALOME_INSTALL_DOC_MAIN ${SALOME_INSTALL_DOC} + CACHE PATH "Install path: main documentation") +SET(SALOME_INSTALL_DOC_GUI ${SALOME_INSTALL_DOC}/gui + CACHE PATH "Install path: user documentation") +SET(SALOME_INSTALL_DOC_TUI ${SALOME_INSTALL_DOC}/tui + CACHE PATH "Install path: developer documentation") +SET(SALOME_INSTALL_DOC_DEV ${SALOME_INSTALL_DOC}/dev + CACHE PATH "Install path: additional developer documentation") +SET(SALOME_INSTALL_DOC_EXAMPLES ${SALOME_INSTALL_DOC}/examples + CACHE PATH "Install path: examples") +SET(SALOME_INSTALL_DOC_EXTRA ${SALOME_INSTALL_DOC}/extra + CACHE PATH "Install path: extra documentation") MARK_AS_ADVANCED( - SALOME_INSTALL_DOC_GUI - SALOME_INSTALL_DOC_TUI - SALOME_INSTALL_DOC_DEV - SALOME_INSTALL_DOC_EXTRA + SALOME_INSTALL_DOC + SALOME_INSTALL_DOC_MAIN + SALOME_INSTALL_DOC_GUI + SALOME_INSTALL_DOC_TUI + SALOME_INSTALL_DOC_DEV + SALOME_INSTALL_DOC_EXAMPLES + SALOME_INSTALL_DOC_EXTRA ) -# Sources -# ===== +# Sources +# ======= +IF(SALOME_INSTALL_MODULES_DOC) + ADD_SUBDIRECTORY(main) +ELSE() + ADD_SUBDIRECTORY(no_main) +ENDIF() ADD_SUBDIRECTORY(tui) ADD_SUBDIRECTORY(gui) -ADD_SUBDIRECTORY(extra) +ADD_SUBDIRECTORY(examples) ADD_SUBDIRECTORY(dev) - -# Install rules -# ========== -FILE(GLOB COMMON_HTML_FILES "${CMAKE_CURRENT_SOURCE_DIR}/*.html") -FILE(GLOB COMMON_PNG_FILES "${CMAKE_CURRENT_SOURCE_DIR}/*.png") - -INSTALL(FILES ${COMMON_HTML_FILES} ${COMMON_PNG_FILES} DESTINATION ${CMAKE_INSTALL_PREFIX}) +ADD_SUBDIRECTORY(extra) diff --git a/FIELDS_index.html b/FIELDS_index.html deleted file mode 100644 index 2e142c7..0000000 --- a/FIELDS_index.html +++ /dev/null @@ -1,36 +0,0 @@ - - - FIELDS Module Documentation - - -

- -

FIELDS Module Documentation

- -

-

-User's Guide -

-MEDCoupling: User's Guide -

-MEDCoupling: Developer's Guide -

-MEDCoupling: Tutorial -

-

- -

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/GEOM_index.html b/GEOM_index.html deleted file mode 100644 index 21603a0..0000000 --- a/GEOM_index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - Geometry Module Documentation - - -

- -

Geometry Module Documentation

- -

-

-User's Guide -

-Developer Documentation -

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/GHS3DPLUGIN_index.html b/GHS3DPLUGIN_index.html deleted file mode 100644 index bd1934b..0000000 --- a/GHS3DPLUGIN_index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - MG-Tetra Meshing Plug-in Documentation - - -

- -

MG-Tetra Meshing Plug-in Documentation

- -

-

-User's Guide -

-

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/GHS3DPRLPLUGIN_index.html b/GHS3DPRLPLUGIN_index.html deleted file mode 100644 index e07bdac..0000000 --- a/GHS3DPRLPLUGIN_index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - MG-Tetra Parallel Meshing Plug-in Documentation - - -

- -

MG-Tetra Parallel Meshing Plug-in Documentation

- -

-

-User's Guide -

-

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/GMSHPLUGIN_index.html b/GMSHPLUGIN_index.html deleted file mode 100644 index c10a668..0000000 --- a/GMSHPLUGIN_index.html +++ /dev/null @@ -1,28 +0,0 @@ - - - GMSH Meshing Plug-in Documentation - - -

- -

GMSH Meshing Plug-in Documentation

- -

-

-User's Guide -

-

-

-

-Copyright © 2014-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-

- - - - - diff --git a/GUI_index.html b/GUI_index.html deleted file mode 100644 index 7fe974a..0000000 --- a/GUI_index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - GUI Module Documentation - - -

- -

GUI Module Documentation

- -

-

-User's Guide -

-Developer Documentation -

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/HELLO_index.html b/HELLO_index.html deleted file mode 100644 index c6955df..0000000 --- a/HELLO_index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - HELLO Sample Module Documentation - - -

- -

HELLO SAMPLE Module Documentation

- -

-

-User's Guide -

-

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/HEXABLOCK_index.html b/HEXABLOCK_index.html deleted file mode 100644 index 6599616..0000000 --- a/HEXABLOCK_index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - HEXABLOCK Module Documentation - - -

- -

HexaBlock Module Documentation

- -

-

-User's Guide - -

-

-

-

-Copyright © 2009-2021 CEA/DEN, EDF R&D
-

- - - - - diff --git a/HOMARD_index.html b/HOMARD_index.html deleted file mode 100644 index 141b845..0000000 --- a/HOMARD_index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - HOMARD Module Documentation - - -

- -

Homard Module Documentation

- -

-

-Users Guide (English version) -

-Users Guide (French version) -

-

-

-

-Copyright © 2013-2021 CEA/DEN, EDF R&D
-

- - - - - diff --git a/HYBRIDPLUGIN_index.html b/HYBRIDPLUGIN_index.html deleted file mode 100644 index 4b98637..0000000 --- a/HYBRIDPLUGIN_index.html +++ /dev/null @@ -1,28 +0,0 @@ - - - Hybrid Meshing Plug-in Documentation - - -

- -

Hybrid Meshing Plug-in Documentation

- -

-

-User's Guide -

-

-

-

-Copyright © 2014-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-

- - - - - diff --git a/HexoticPLUGIN_index.html b/HexoticPLUGIN_index.html deleted file mode 100644 index 14c1f1c..0000000 --- a/HexoticPLUGIN_index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - MG-Hexa Meshing Plug-in Documentation - - -

- -

MG-Hexa Meshing Plug-in Documentation

- -

-

-User's Guide -

-

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/JOBMANAGER_index.html b/JOBMANAGER_index.html deleted file mode 100644 index 7386592..0000000 --- a/JOBMANAGER_index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - JOBMANAGER Module Documentation - - -

- -

JobManager Module Documentation

- -

-

-User's Guide - -

-

-

-Copyright © 2010-2021 CEA/DEN, EDF R&D
-

- - - - - diff --git a/KERNEL_index.html b/KERNEL_index.html deleted file mode 100644 index ed12118..0000000 --- a/KERNEL_index.html +++ /dev/null @@ -1,28 +0,0 @@ - - - Kernel Module Documentation - - -

- -

Kernel Module Documentation

- -

-

-Developer Documentation -

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/NETGENPLUGIN_index.html b/NETGENPLUGIN_index.html deleted file mode 100644 index 97a5778..0000000 --- a/NETGENPLUGIN_index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - Netgen Meshing Plug-in Documentation - - -

- -

Netgen Meshing Plug-in Documentation

- -

-

-User's Guide -

-

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/PARAVIS_index.html b/PARAVIS_index.html deleted file mode 100644 index da1fccf..0000000 --- a/PARAVIS_index.html +++ /dev/null @@ -1,28 +0,0 @@ - - - Post-Pro Module Documentation - - -

- -

PARAVIS Module Documentation

- -

-

-Developer Documentation -

-

-

-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-

- - - - - diff --git a/PYHELLO_index.html b/PYHELLO_index.html deleted file mode 100644 index 8a4db9c..0000000 --- a/PYHELLO_index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - PYHELLO Sample Module Documentation - - -

- -

PYHELLO SAMPLE Module Documentation

- -

-

-User's Guide -

-

-

-

- - - - - diff --git a/SHAPER_index.html b/SHAPER_index.html deleted file mode 100644 index eec5013..0000000 --- a/SHAPER_index.html +++ /dev/null @@ -1,29 +0,0 @@ - - - Shaper Module Documentation - - -

- -

Shaper Module Documentation

- -

-

-User's Guide -

-Developer Documentation -

-

-

- - - - - diff --git a/SMESH_index.html b/SMESH_index.html deleted file mode 100644 index e939da4..0000000 --- a/SMESH_index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - Mesh Module Documentation - - -

- -

Mesh Module Documentation

- -

-

-User's Guide -

-Developer Documentation -

-

-

- - - - - diff --git a/YACS_index.html b/YACS_index.html deleted file mode 100644 index 83d971d..0000000 --- a/YACS_index.html +++ /dev/null @@ -1,30 +0,0 @@ - - - YACS Module Documentation - - -

- -

YACS Module Documentation

- -

-

-User's Guide -

-Developer Documentation -

-

-

- - - - - diff --git a/about.png b/about.png deleted file mode 100644 index b3aac3c..0000000 Binary files a/about.png and /dev/null differ diff --git a/cmake/DocumentationMacros.cmake b/cmake/DocumentationMacros.cmake new file mode 100644 index 0000000..6c8cfb3 --- /dev/null +++ b/cmake/DocumentationMacros.cmake @@ -0,0 +1,73 @@ +# ============================================================================== +# SALOME_CREATE_SYMLINK macro creates symbolic link during installation step +# +# USAGE: SALOME_CREATE_SYMLINK(src_path link_path) +# +# ARGUMENTS: +# +# src_path Source path to the file or directory. +# link_path Target symbolic link path. +# +# WARNING: Link is created only on those platforms which support this. +# +# ============================================================================== + +MACRO(SALOME_CREATE_SYMLINK src_path link_path) + INSTALL(CODE " + IF(EXISTS \"${src_path}\") + MESSAGE(STATUS \"Creating symbolic link \$ENV{DESTDIR}${CMAKE_INSTALL_PREFIX}/${link_path}\") + GET_FILENAME_COMPONENT(_path \"$ENV{DESTDIR}${CMAKE_INSTALL_PREFIX}/${link_path}\" DIRECTORY) + EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E make_directory + \"\${_path}\") + EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E create_symlink + \"${src_path}\" \"\$ENV{DESTDIR}${CMAKE_INSTALL_PREFIX}/${link_path}\") + ENDIF() + ") +ENDMACRO() + +# ============================================================================== +# SALOME_INSTALL_MODULE_DOC macro creates symbolic link during installation step +# +# USAGE: SALOME_INSTALL_MODULE_DOC(src ... DESTINATION dest_dir [INDEX index_dir ...]) +# +# ARGUMENTS: +# +# src Directory of file to install. +# dest_dir Target directory. +# index_dir Sub-directory(-ies) to put stub index file. +# +# ============================================================================== + +MACRO(SALOME_INSTALL_MODULE_DOC) + CMAKE_PARSE_ARGUMENTS(_SALOME_INSTALL_MODULE_DOC "" "DESTINATION" "INDEX" ${ARGN}) + SET(_args ${_SALOME_INSTALL_MODULE_DOC_UNPARSED_ARGUMENTS}) + IF(SALOME_INSTALL_MODULES_DOC) + FOREACH(_arg ${_args}) + GET_FILENAME_COMPONENT(_arg_name ${_arg} NAME) + IF(EXISTS "${_arg}") + IF(NOT WIN32 AND SALOME_CREATE_SYMLINKS) + SALOME_CREATE_SYMLINK("${_arg}" "${_SALOME_INSTALL_MODULE_DOC_DESTINATION}/${_arg_name}") + ELSE() + IF(IS_DIRECTORY "${_arg}") + INSTALL(DIRECTORY "${_arg}" + DESTINATION "${_SALOME_INSTALL_MODULE_DOC_DESTINATION}") + ELSE() + INSTALL(FILES "${_arg}" + DESTINATION "${_SALOME_INSTALL_MODULE_DOC_DESTINATION}") + ENDIF() + ENDIF() + ELSE() + IF(_SALOME_INSTALL_MODULE_DOC_INDEX) + FOREACH(_index ${_SALOME_INSTALL_MODULE_DOC_INDEX}) + SET(_install_dir "${_SALOME_INSTALL_MODULE_DOC_DESTINATION}/${_arg_name}/${_index}") + INSTALL(FILES ${CMAKE_SOURCE_DIR}/cmake/dummy_index.html DESTINATION "${_install_dir}" RENAME index.html) + ENDFOREACH() + ELSE() + SET(_install_dir "${_SALOME_INSTALL_MODULE_DOC_DESTINATION}/${_arg_name}") + INSTALL(FILES ${CMAKE_SOURCE_DIR}/cmake/dummy_index.html DESTINATION "${_install_dir}" RENAME index.html) + ENDIF() + ENDIF() + ENDFOREACH() + ENDIF() + UNSET(_args) +ENDMACRO() diff --git a/cmake/dummy_index.html b/cmake/dummy_index.html new file mode 100644 index 0000000..5cc5b63 --- /dev/null +++ b/cmake/dummy_index.html @@ -0,0 +1,8 @@ + + + Documentation is not build! + + +This documentation has not been built! + + diff --git a/dev/CMakeLists.txt b/dev/CMakeLists.txt index 744e08b..35dd2a7 100644 --- a/dev/CMakeLists.txt +++ b/dev/CMakeLists.txt @@ -16,5 +16,39 @@ # # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # + +# Install content from subdirs +# ============================ + ADD_SUBDIRECTORY(git) ADD_SUBDIRECTORY(cmake) + +# Install [dev] documentation for SALOME modules +# ============================================== + +SET(_modules + FIELDS + PARAVIS +) + +FOREACH(_module ${_modules}) + SET(${_module}_ROOT_DIR $ENV{${_module}_ROOT_DIR}) + IF(${_module}_ROOT_DIR) + SALOME_INSTALL_MODULE_DOC(${${_module}_ROOT_DIR}/share/doc/salome/dev/${_module} + DESTINATION ${SALOME_INSTALL_DOC_DEV}) + ENDIF() +ENDFOREACH() + +# Special processing for MEDCoupling +# ================================== + +SET(MEDCOUPLING_ROOT_DIR $ENV{MEDCOUPLING_ROOT_DIR}) +IF(MEDCOUPLING_ROOT_DIR) + SALOME_INSTALL_MODULE_DOC(${MEDCOUPLING_ROOT_DIR}/share/doc/developer + DESTINATION ${SALOME_INSTALL_DOC_DEV}/MEDCoupling) + SALOME_INSTALL_MODULE_DOC(${MEDCOUPLING_ROOT_DIR}/share/doc/tutorial + DESTINATION ${SALOME_INSTALL_DOC_DEV}/MEDCoupling) + SALOME_INSTALL_MODULE_DOC(${MEDCOUPLING_ROOT_DIR}/share/doc/user + DESTINATION ${SALOME_INSTALL_DOC_DEV}/MEDCoupling + INDEX html) +ENDIF() diff --git a/dev/README b/dev/README index 081a952..eaa7892 100644 --- a/dev/README +++ b/dev/README @@ -1 +1 @@ -This directory contains Extra developer documentation by modules. +This directory contains extra developer documentation. diff --git a/dev/cmake/CMakeLists.txt b/dev/cmake/CMakeLists.txt index b6e4366..351c479 100644 --- a/dev/cmake/CMakeLists.txt +++ b/dev/cmake/CMakeLists.txt @@ -17,16 +17,19 @@ # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # -# Include common macros -# ================== -INCLUDE(SalomeDocumentationMacros) - SALOME_CONFIGURE_FILE(source/conf.py.in conf.py) -# Add sphinx documentation target -# ============================ -SALOME_ADD_SPHINX_DOC(html cmake_doc ${CMAKE_CURRENT_SOURCE_DIR}/source ${CMAKE_CURRENT_BINARY_DIR}) +# Build with sphinx +# ================= + +SALOME_ADD_SPHINX_DOC(html + cmake_doc + ${CMAKE_CURRENT_SOURCE_DIR}/source + ${CMAKE_CURRENT_BINARY_DIR}) + +# Install +# ======= -# Install rules -# ========== -INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/_build/html DESTINATION ${SALOME_INSTALL_DOC_DEV}/cmake) +INSTALL(DIRECTORY + ${CMAKE_CURRENT_BINARY_DIR}/_build/html + DESTINATION ${SALOME_INSTALL_DOC_DEV}/cmake) diff --git a/dev/git/CMakeLists.txt b/dev/git/CMakeLists.txt index 97d1419..2c656ed 100644 --- a/dev/git/CMakeLists.txt +++ b/dev/git/CMakeLists.txt @@ -17,19 +17,23 @@ # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # -# Include common macros -# ================== -INCLUDE(SalomeDocumentationMacros) - SALOME_CONFIGURE_FILE(conf.py.in conf.py) -# Add sphinx documentation target -# ============================ -SALOME_ADD_SPHINX_DOC( html git_doc ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}) +# Build with sphinx +# ================= + +SALOME_ADD_SPHINX_DOC(html + git_doc + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_BINARY_DIR}) + +# Install +# ======= -# Install rules -# ========== -INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/_build/html DESTINATION ${SALOME_INSTALL_DOC_DEV}/git) +INSTALL(DIRECTORY + ${CMAKE_CURRENT_BINARY_DIR}/_build/html + DESTINATION ${SALOME_INSTALL_DOC_DEV}/git) -FILE(GLOB COMMON_DOCX_FIELS "${CMAKE_CURRENT_SOURCE_DIR}/*.docx") -INSTALL(FILES ${COMMON_DOCX_FIELS} DESTINATION ${SALOME_INSTALL_DOC_DEV}/git) +INSTALL(FILES + Switch-To-GIT-2013-06.docx + DESTINATION ${SALOME_INSTALL_DOC_DEV}/git) diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt new file mode 100644 index 0000000..038fa14 --- /dev/null +++ b/examples/CMakeLists.txt @@ -0,0 +1,40 @@ +# Copyright (C) 2012-2021 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 +# License as published by the Free Software Foundation; either +# 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 +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +# Install [examples] documentation for SALOME modules +# =================================================== + +SET(_modules + BLSURFPLUGIN + GEOM + GHS3DPLUGIN + GMSHPLUGIN + HYBRIDPLUGIN + HexoticPLUGIN + NETGENPLUGIN + SMESH +) + +FOREACH(_module ${_modules}) + SET(${_module}_ROOT_DIR $ENV{${_module}_ROOT_DIR}) + IF(${_module}_ROOT_DIR) + SALOME_INSTALL_MODULE_DOC(${${_module}_ROOT_DIR}/share/doc/salome/examples/${_module} + DESTINATION ${SALOME_INSTALL_DOC_EXAMPLES}) + ENDIF() +ENDFOREACH() diff --git a/extra/CMakeLists.txt b/extra/CMakeLists.txt index b794481..71889e1 100644 --- a/extra/CMakeLists.txt +++ b/extra/CMakeLists.txt @@ -17,7 +17,8 @@ # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # -# Install rules -# =========== +# Install +# ======= + FILE(GLOB COMMON_PDF_FILES "${CMAKE_CURRENT_SOURCE_DIR}/*.pdf") INSTALL(FILES ${COMMON_PDF_FILES} DESTINATION ${SALOME_INSTALL_DOC_EXTRA}) diff --git a/fr.png b/fr.png deleted file mode 100644 index 326eaab..0000000 Binary files a/fr.png and /dev/null differ diff --git a/gui/CMakeLists.txt b/gui/CMakeLists.txt index 10ec9c3..57b25d9 100644 --- a/gui/CMakeLists.txt +++ b/gui/CMakeLists.txt @@ -17,6 +17,53 @@ # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # -# Install rules -# ========== -INSTALL(FILES README DESTINATION ${SALOME_INSTALL_DOC_GUI}) +# Install [gui] documentation for SALOME modules +# ============================================== + +SET(_modules + BLSURFPLUGIN + EFICAS + GEOM + GHS3DPLUGIN + GHS3DPRLPLUGIN + GMSHPLUGIN + GUI + HELLO + HEXABLOCK + HYBRIDPLUGIN + HexoticPLUGIN + JOBMANAGER + NETGENPLUGIN + PYHELLO + SHAPER + SMESH + YACS +) + +FOREACH(_module ${_modules}) + SET(${_module}_ROOT_DIR $ENV{${_module}_ROOT_DIR}) + IF(${_module}_ROOT_DIR) + SALOME_INSTALL_MODULE_DOC(${${_module}_ROOT_DIR}/share/doc/salome/gui/${_module} + DESTINATION ${SALOME_INSTALL_DOC_GUI}) + ENDIF() +ENDFOREACH() + +# Special processing for HOMARD +# ============================= + +SET(HOMARD_ROOT_DIR $ENV{HOMARD_ROOT_DIR}) +IF(HOMARD_ROOT_DIR) + SALOME_INSTALL_MODULE_DOC(${HOMARD_ROOT_DIR}/share/doc/salome/gui/HOMARD + DESTINATION ${SALOME_INSTALL_DOC_GUI} + INDEX en fr) +ENDIF() + +# Special processing for ADAO +# =========================== + +SET(ADAO_ROOT_DIR $ENV{ADAO_ROOT_DIR}) +IF(ADAO_ROOT_DIR) + SALOME_INSTALL_MODULE_DOC(${ADAO_ROOT_DIR}/share/doc/gui/ADAO + DESTINATION ${SALOME_INSTALL_DOC_GUI} + INDEX en fr) +ENDIF() diff --git a/gui/README b/gui/README deleted file mode 100644 index 757f0db..0000000 --- a/gui/README +++ /dev/null @@ -1 +0,0 @@ -This directory contains User's Guide documentation by modules. diff --git a/head.png b/head.png deleted file mode 100644 index 307d9ef..0000000 Binary files a/head.png and /dev/null differ diff --git a/index.html b/index.html deleted file mode 100644 index 07d405e..0000000 --- a/index.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - -SALOME Developer Documentation - - - - - - -

- -

Developer's Documentation

- -

Architecture

- - SALOME GUI Architecture (PDF, 1 MB) - -

- -

Module Development

See SALOME Tutorial
- - Implement Dump Python (PDF, 67 KB) -

- -

Mesh

- - Use of SMDS API (PDF, 416 KB) - -
- - Integration of new meshing algorithm as plug-in to SALOME Mesh module (PDF, 91 KB) -

- -

Code Coupling

- -

Installation procedure

Build procedure (CMake)

- -

Development

Contributing to the SALOME project with Git

- - - - - - - - - - - - - -


	= Document is not up to date
	= Document in French

- -
-

- -

SALOME Tutorial

- The SALOME Tutorial provides an introduction to the development of new modules and integrating them to SALOME platform, as well as new applications based on SALOME.
- The tutorial can be downloaded from SALOME site. -

- -

-

- - - diff --git a/main/CMakeLists.txt b/main/CMakeLists.txt new file mode 100644 index 0000000..93fa9ce --- /dev/null +++ b/main/CMakeLists.txt @@ -0,0 +1,36 @@ +# Copyright (C) 2012-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 +# License as published by the Free Software Foundation; either +# 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 +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +SALOME_CONFIGURE_FILE(conf.py.in conf.py) + +# Build with sphinx +# ================= + +SALOME_ADD_SPHINX_DOC(html + main_doc + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_BINARY_DIR} + OUTDIR main) + +# Install +# ======= + +INSTALL(DIRECTORY + ${CMAKE_CURRENT_BINARY_DIR}/_build/main + DESTINATION ${SALOME_INSTALL_DOC_MAIN}) diff --git a/main/conf.py.in b/main/conf.py.in new file mode 100644 index 0000000..edf7ca4 --- /dev/null +++ b/main/conf.py.in @@ -0,0 +1,255 @@ +# -*- coding: utf-8 -*- +# +# CMake build procedure documentation build configuration file, created by +# sphinx-quickstart on Tue Jul 2 14:10:22 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import os +import re +import sys +import sphinx + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [] +try: + import sphinx_rtd_theme + extensions += ['sphinx_rtd_theme'] + use_rtd_theme = True +except: + use_rtd_theme = False + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'SALOME documentation' +copyright = u'2020, OPEN CASCADE' +author = u'OPEN CASCADE' +doc_name = 'salome_documentation' +doc_title = project + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '@SALOMEDOCUMENTATION_VERSION@' +# The short X.Y version. +version = list(map(int, re.sub('[A-Za-z]+[0-9]*$', '', release).split('.'))) +version = version[:2] if len(version) > 2 and version[-1] == 0 else version +version = 'Version ' + '.'.join(map(str, version)) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +if use_rtd_theme: + html_theme = 'sphinx_rtd_theme' +else: + html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +themes_options = dict( + classic = {'body_max_width': 'none', + 'body_min_width': 0, + }) +html_theme_options = themes_options.get(html_theme, {}) + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +html_title = 'SALOME v{version} documentation'.format(version=version) + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = '@CMAKE_CURRENT_SOURCE_DIR@/images/logo.png' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# 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'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = doc_name + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + (master_doc, doc_name, doc_title, author, 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, doc_name, doc_title, author, 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, doc_name, doc_title, author, 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' diff --git a/main/gui.rst b/main/gui.rst new file mode 100644 index 0000000..0653d47 --- /dev/null +++ b/main/gui.rst @@ -0,0 +1,90 @@ +.. _gui: + +.. figure:: /images/head.png + :align: center + +User's Documentation +==================== + +This chapter provides description of graphical user interface of **SALOME platform**. +Please use links below to learn about GUI features of particular SALOME module. + +* `GUI module <../gui/GUI/index.html>`__ + +*This section contains SALOME GUI module documentation. It provides a description +of the basic functionalities available in the SALOME GUI desktop.* + +* `Shaper module <../gui/SHAPER/index.html>`__ + +*This section contains the documentation on the SALOME Shaper module. Shaper is a +CAD modeler which came as a replacement for the former Geometry module.* + +* `Geometry module <../gui/GEOM/index.html>`__ + +*This section contains the documentation on the SALOME Geometry module. This module +can be used for creation/editing of the CAD models.* + +* `Mesh module <../gui/SMESH/index.html>`__ + +*This section contains the documentation on the SALOME Mesh module. This module +can be used for generating mesh from the CAD model.* + +* Meshing plug-in modules: + + * `Netgen plugin module <../gui/NETGENPLUGIN/index.html>`__ + * `MG-CADSurf plugin module <../gui/BLSURFPLUGIN/index.html>`__ + * `MG-Tetra plugin module <../gui/GHS3DPLUGIN/index.html>`__ + * `MG-Tetra Parallel plugin module <../gui/GHS3DPRLPLUGIN/index.html>`__ + * `MG-Hexa plugin module <../gui/HexoticPLUGIN/index.html>`__ + * `MG-Hybrid plugin module <../gui/HYBRIDPLUGIN/index.html>`__ + * `Gmsh plugin module <../gui/GMSHPLUGIN/index.html>`__ + +* `Fields module <../dev/FIELDS/index.html>`__ + +*This is the documentation on the SALOME Fields (formed Med) module. In addition, +the following documentation is available:* + + * `MEDCoupling: User's Guide <../dev/MEDCoupling/user/html/index.html>`__ + * `MEDCoupling: Developer's Guide <../dev/MEDCoupling/developer/index.html>`__ + * `MEDCoupling: Tutorial <../dev/MEDCoupling/tutorial/index.html>`__ + +* `YACS module <../gui/YACS/index.html>`__ + +*This section contains documentation on the SALOME YACS module. YACS is an alternative +implementation of the Supervisor module, that has replaced SUPERV since SALOME series 4x.* + +* `HexaBlock module <../gui/HEXABLOCK/index.html>`__ + +*This section contains documentation on the SALOME HexaBlock module. This module aims +at helping users to build hexahedral meshes by creating of a model of the blocks.* + +* Homard module + +*This section contains documentation about SALOME Homard module. This module provides +means for the adaptation of the mesh generated by the Homard solver for the SALOME +platform.* + + * `English version <../gui/HOMARD/en/index.html>`__ + * `French version <../gui/HOMARD/fr/index.html>`__ + +* ADAO module + +*This section contains documentation about SALOME ADAO module. This module provides data assimilation and optimization features in Python or SALOME context.* + + * `English version <../gui/ADAO/en/index.html>`__ + * `French version <../gui/ADAO/fr/index.html>`__ + +* `EFICAS module <../gui/EFICAS/index.html>`__ + +*This section contains documentation on the SALOME EFICAS module.* + +* `JobManager module <../gui/JOBMANAGER/index.html>`__ + +*This section contains documentation about SALOME JobManager module.* + +* Samples + +*This section contains documentation for some sample modules.* + + * `HELLO sample module <../gui/HELLO/index.html>`__ + * `PYHELLO Documentation <../gui/PYHELLO/index.html>`__ diff --git a/main/images/fr.png b/main/images/fr.png new file mode 100644 index 0000000..7814417 Binary files /dev/null and b/main/images/fr.png differ diff --git a/main/images/head.png b/main/images/head.png new file mode 100644 index 0000000..307d9ef Binary files /dev/null and b/main/images/head.png differ diff --git a/main/images/logo.png b/main/images/logo.png new file mode 100644 index 0000000..3a10a28 Binary files /dev/null and b/main/images/logo.png differ diff --git a/main/images/pdf.png b/main/images/pdf.png new file mode 100644 index 0000000..45788bc Binary files /dev/null and b/main/images/pdf.png differ diff --git a/main/images/warn.png b/main/images/warn.png new file mode 100644 index 0000000..dffbcc3 Binary files /dev/null and b/main/images/warn.png differ diff --git a/main/index.rst b/main/index.rst new file mode 100644 index 0000000..1351d1a --- /dev/null +++ b/main/index.rst @@ -0,0 +1,31 @@ +.. _main: + +.. figure:: /images/head.png + :align: center + +.. toctree:: + :hidden: + + gui + tui + +%%%%%%%%%%%% +Introduction +%%%%%%%%%%%% + +Welcome to the SALOME documentation. Please learn more about SALOME by clicking the links below. + +* `Video Tutorials`_ + +* `Learn SALOME channel`_ + +* `SALOME Tutoriels channel`_ + +* :doc:`gui` + +* :doc:`tui` + +.. _Video Tutorials: https://www.youtube.com/playlist?list=PLgvBxFyGVRbZZz4wVvP36xXQL-S81RZsc&disable_polymer=true +.. _Learn SALOME channel: https://www.youtube.com/channel/UCm7CSP3v1VF6brzmTlV9c3Q +.. _SALOME Tutoriels channel: https://www.youtube.com/channel/UCokrSqnpG3sLXkagZwUmuXg + diff --git a/main/tui.rst b/main/tui.rst new file mode 100644 index 0000000..5e753f4 --- /dev/null +++ b/main/tui.rst @@ -0,0 +1,112 @@ +.. _tui: + +.. figure:: /images/head.png + :align: center + +Developer's Documentation +========================= + +This chapter contains different reference manuals and other documents which can be +helpful for the developers who wants to customize the **SALOME platform** or develop +new features, modules, plugins, etc. + +Modules documentation +--------------------- + +* `KERNEL module <../tui/KERNEL/index.html>`__ + +*This is the developer reference manual for the SALOME KERNEL module. It provides a general +description of the main services implemented within the KERNEL module.* + +* `GUI module <../tui/GUI/index.html>`__ + +*This is the developer reference manual for the SALOME GUI module. It provides a description +of the basic functionalities available in the GUI module.* + +* `Shaper module <../tui/SHAPER/index.html>`__ + +*This section contains developer reference manual for the SALOME Shaper module. Shaper is a +CAD modeler which came as a replacement for the former Geometry module.* + +* `Geometry module <../tui/GEOM/index.html>`__ + +This section contains developer reference manual for the SALOME Geometry module, the legacy +CAD modeler of the SALOME platform.* + +* `Mesh module <../tui/SMESH/index.html>`__ + +*This is the developer reference manual for the SALOME Mesh module. This module can be used +for generating of the meshes from the CAD model prepared in Geometry or Shaper.* + +* `YACS module <../tui/YACS/index.html>`__ + +*This section contains developer reference manual for the SALOME YACS module.* + +* `Fields module <../dev/FIELDS/index.html>`__ + +*This section contains developer reference manual for the SALOME Fields module formely known +as Med module.* + +* `ParaVis module <../dev/PARAVIS/index.html>`__ + +*This section contains developer reference manual for the SALOME ParaVis module.* + +Guides +------ + +.. |pdf| image:: /images/pdf.png + :height: 16px +.. |warn| image:: /images/warn.png + :height: 16px +.. |fr| image:: /images/fr.png + :height: 16px + +.. table:: + + +--------+----------------------------+ + | Legend | + +========+============================+ + | |warn| | Document is not up to date | + +--------+----------------------------+ + | |fr| | Document in French | + +--------+----------------------------+ + | |pdf| | Document in PDF format | + +--------+----------------------------+ + +Architecture +~~~~~~~~~~~~ + +* |pdf| `SALOME GUI Architecture <../extra/SALOME_GUI_Architecture.pdf>`__ (PDF, 1 MB) |warn| + +Module Development +~~~~~~~~~~~~~~~~~~ + +* The **SALOME Tutorial** provides an introduction to the development of new modules + and integrating them to the SALOME platform, as well as new applications based on SALOME. + The tutorial can be downloaded from `SALOME site `__. + +* |pdf| `Implement Dump Python <../extra/DumpPython_Extension.pdf>`__ (PDF, 67 KB) + +Mesh +~~~~ + +* |pdf| `Use of SMDS API <../extra/SALOME_4.1.2_SMDS_reference_guide.pdf>`__ (PDF, 416 KB) |warn| +* |pdf| `Integration of new meshing algorithm as plug-in to SALOME Mesh module <../extra/SALOME_Mesh_Plugins.pdf>`__ (PDF, 91 KB) + +Code Coupling +~~~~~~~~~~~~~ + +* |pdf| `Normalisation des maillages et des champs pour le couplage <../extra/Normalisation_pour_le_couplage_de_codes.pdf>`__ (PDF, 1 MB) |fr| +* |pdf| `Documentation of the Interface for Code Coupling / ICoCo <../extra/Interface_for_Code_Coupling.pdf>`__ (PDF, 1.6 MB) |fr| +* |pdf| `Le couplage de codes paralleles dans la plateforme SALOME <../extra/Couplage_de_codes_paralleles.pdf>`__ (PDF, 589 KB) |fr| +* |pdf| `DÃ©monstrateur couplage fluide structure EDF <../extra/Demonstrateur_couplage_fluide_structure_EDF.pdf>`__ (PDF, 1.2 MB) |fr| + +Installation procedure +~~~~~~~~~~~~~~~~~~~~~~ + +* `Build procedure <../dev/cmake/html/index.html>`__ (CMake) + +Development +~~~~~~~~~~~ + +* `Contributing to the SALOME project with Git <../dev/git/html/Git_Simple_Write_Procedure.html>`__ diff --git a/no_main/CMakeLists.txt b/no_main/CMakeLists.txt new file mode 100644 index 0000000..ccc5c6d --- /dev/null +++ b/no_main/CMakeLists.txt @@ -0,0 +1,36 @@ +# Copyright (C) 2012-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 +# License as published by the Free Software Foundation; either +# 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 +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +SALOME_CONFIGURE_FILE(conf.py.in conf.py) + +# Build with sphinx +# ================= + +SALOME_ADD_SPHINX_DOC(html + nomain_doc + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_BINARY_DIR} + OUTDIR main) + +# Install +# ======= + +INSTALL(DIRECTORY + ${CMAKE_CURRENT_BINARY_DIR}/_build/main + DESTINATION ${SALOME_INSTALL_DOC_MAIN}) diff --git a/no_main/conf.py.in b/no_main/conf.py.in new file mode 100644 index 0000000..edf7ca4 --- /dev/null +++ b/no_main/conf.py.in @@ -0,0 +1,255 @@ +# -*- coding: utf-8 -*- +# +# CMake build procedure documentation build configuration file, created by +# sphinx-quickstart on Tue Jul 2 14:10:22 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import os +import re +import sys +import sphinx + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [] +try: + import sphinx_rtd_theme + extensions += ['sphinx_rtd_theme'] + use_rtd_theme = True +except: + use_rtd_theme = False + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'SALOME documentation' +copyright = u'2020, OPEN CASCADE' +author = u'OPEN CASCADE' +doc_name = 'salome_documentation' +doc_title = project + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = '@SALOMEDOCUMENTATION_VERSION@' +# The short X.Y version. +version = list(map(int, re.sub('[A-Za-z]+[0-9]*$', '', release).split('.'))) +version = version[:2] if len(version) > 2 and version[-1] == 0 else version +version = 'Version ' + '.'.join(map(str, version)) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +if use_rtd_theme: + html_theme = 'sphinx_rtd_theme' +else: + html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +themes_options = dict( + classic = {'body_max_width': 'none', + 'body_min_width': 0, + }) +html_theme_options = themes_options.get(html_theme, {}) + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +html_title = 'SALOME v{version} documentation'.format(version=version) + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = '@CMAKE_CURRENT_SOURCE_DIR@/images/logo.png' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# 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'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = doc_name + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + (master_doc, doc_name, doc_title, author, 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, doc_name, doc_title, author, 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, doc_name, doc_title, author, 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' diff --git a/no_main/images/fr.png b/no_main/images/fr.png new file mode 100644 index 0000000..7814417 Binary files /dev/null and b/no_main/images/fr.png differ diff --git a/no_main/images/head.png b/no_main/images/head.png new file mode 100644 index 0000000..307d9ef Binary files /dev/null and b/no_main/images/head.png differ diff --git a/no_main/images/logo.png b/no_main/images/logo.png new file mode 100644 index 0000000..3a10a28 Binary files /dev/null and b/no_main/images/logo.png differ diff --git a/no_main/images/pdf.png b/no_main/images/pdf.png new file mode 100644 index 0000000..45788bc Binary files /dev/null and b/no_main/images/pdf.png differ diff --git a/no_main/images/warn.png b/no_main/images/warn.png new file mode 100644 index 0000000..dffbcc3 Binary files /dev/null and b/no_main/images/warn.png differ diff --git a/no_main/index.rst b/no_main/index.rst new file mode 100644 index 0000000..30f6f37 --- /dev/null +++ b/no_main/index.rst @@ -0,0 +1,28 @@ +.. _main: + +.. figure:: /images/head.png + :align: center + +.. toctree:: + :hidden: + + gui + tui + +%%%%%%%%%%%% +Introduction +%%%%%%%%%%%% + +Welcome to the SALOME documentation. Please learn more about SALOME by clicking the links below. + +* `Video Tutorials`_ + +* `Learn SALOME channel`_ + +* `SALOME Tutoriels channel`_ + +* :doc:`tui` + +.. _Video Tutorials: https://www.youtube.com/playlist?list=PLgvBxFyGVRbZZz4wVvP36xXQL-S81RZsc&disable_polymer=true +.. _Learn SALOME channel: https://www.youtube.com/channel/UCm7CSP3v1VF6brzmTlV9c3Q +.. _SALOME Tutoriels channel: https://www.youtube.com/channel/UCokrSqnpG3sLXkagZwUmuXg diff --git a/no_main/tui.rst b/no_main/tui.rst new file mode 100644 index 0000000..f32409c --- /dev/null +++ b/no_main/tui.rst @@ -0,0 +1,68 @@ +.. _tui: + +.. figure:: /images/head.png + :align: center + +Developer's Documentation +========================= + +This chapter contains different reference manuals and other documents which can be +helpful for the developers who wants to customize the **SALOME platform** or develop +new features, modules, plugins, etc. + +.. |pdf| image:: /images/pdf.png + :height: 16px +.. |warn| image:: /images/warn.png + :height: 16px +.. |fr| image:: /images/fr.png + :height: 16px + +.. table:: + + +--------+----------------------------+ + | Legend | + +========+============================+ + | |warn| | Document is not up to date | + +--------+----------------------------+ + | |fr| | Document in French | + +--------+----------------------------+ + | |pdf| | Document in PDF format | + +--------+----------------------------+ + +Architecture +~~~~~~~~~~~~ + +* |pdf| `SALOME GUI Architecture <../extra/SALOME_GUI_Architecture.pdf>`__ (PDF, 1 MB) |warn| + +Module Development +~~~~~~~~~~~~~~~~~~ + +* The **SALOME Tutorial** provides an introduction to the development of new modules + and integrating them to the SALOME platform, as well as new applications based on SALOME. + The tutorial can be downloaded from `SALOME site `__. + +* |pdf| `Implement Dump Python <../extra/DumpPython_Extension.pdf>`__ (PDF, 67 KB) + +Mesh +~~~~ + +* |pdf| `Use of SMDS API <../extra/SALOME_4.1.2_SMDS_reference_guide.pdf>`__ (PDF, 416 KB) |warn| +* |pdf| `Integration of new meshing algorithm as plug-in to SALOME Mesh module <../extra/SALOME_Mesh_Plugins.pdf>`__ (PDF, 91 KB) + +Code Coupling +~~~~~~~~~~~~~ + +* |pdf| `Normalisation des maillages et des champs pour le couplage <../extra/Normalisation_pour_le_couplage_de_codes.pdf>`__ (PDF, 1 MB) |fr| +* |pdf| `Documentation of the Interface for Code Coupling / ICoCo <../extra/Interface_for_Code_Coupling.pdf>`__ (PDF, 1.6 MB) |fr| +* |pdf| `Le couplage de codes paralleles dans la plateforme SALOME <../extra/Couplage_de_codes_paralleles.pdf>`__ (PDF, 589 KB) |fr| +* |pdf| `DÃ©monstrateur couplage fluide structure EDF <../extra/Demonstrateur_couplage_fluide_structure_EDF.pdf>`__ (PDF, 1.2 MB) |fr| + +Installation procedure +~~~~~~~~~~~~~~~~~~~~~~ + +* `Build procedure <../dev/cmake/html/index.html>`__ (CMake) + +Development +~~~~~~~~~~~ + +* `Contributing to the SALOME project with Git <../dev/git/html/Git_Simple_Write_Procedure.html>`__ diff --git a/pdf.png b/pdf.png deleted file mode 100644 index 096d894..0000000 Binary files a/pdf.png and /dev/null differ diff --git a/tui/CMakeLists.txt b/tui/CMakeLists.txt index 9d1330c..810a525 100644 --- a/tui/CMakeLists.txt +++ b/tui/CMakeLists.txt @@ -17,6 +17,23 @@ # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com # -# Install rules -# ========== -INSTALL(FILES README DESTINATION ${SALOME_INSTALL_DOC_TUI}) +# Install [tui] documentation for SALOME modules +# ============================================== + +SET(_modules + BLSURFPLUGIN + GEOM + GUI + KERNEL + SHAPER + SMESH + YACS +) + +FOREACH(_module ${_modules}) + SET(${_module}_ROOT_DIR $ENV{${_module}_ROOT_DIR}) + IF(${_module}_ROOT_DIR) + SALOME_INSTALL_MODULE_DOC(${${_module}_ROOT_DIR}/share/doc/salome/tui/${_module} + DESTINATION ${SALOME_INSTALL_DOC_TUI}) + ENDIF() +ENDFOREACH() diff --git a/tui/README b/tui/README deleted file mode 100644 index 6214c0c..0000000 --- a/tui/README +++ /dev/null @@ -1 +0,0 @@ -This directory contains Developer documentation by modules. diff --git a/warn.png b/warn.png deleted file mode 100644 index be7b36e..0000000 Binary files a/warn.png and /dev/null differ