+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>MG-CADSurf Meshing Plug-in Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>MG-CADSurf Meshing Plug-in Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/BLSURFPLUGIN/index.html">User's Guide</a></big>
-<br><br>
-<big><a href="tui/BLSURFPLUGIN/index.html">Developer Documentation</a></big>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
#
# 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)
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)
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)
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>FIELDS Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>FIELDS Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="dev/FIELDS/index.html">User's Guide</a></big>
-<br><br>
-<big><a href="dev/MEDCoupling/user/html/index.html">MEDCoupling: User's Guide</a></big>
-<br><br>
-<big><a href="dev/MEDCoupling/developer/index.html">MEDCoupling: Developer's Guide</a></big>
-<br><br>
-<big><a href="dev/MEDCoupling/tutorial/index.html">MEDCoupling: Tutorial</a></big>
-<br><br>
-</div>
-</div>
-<br><br><br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>Geometry Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>Geometry Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/GEOM/index.html">User's Guide</a></big>
-<br><br>
-<big><a href="tui/GEOM/index.html">Developer Documentation</a></big>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>MG-Tetra Meshing Plug-in Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>MG-Tetra Meshing Plug-in Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/GHS3DPLUGIN/index.html">User's Guide</a></big>
-<br><br><br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>MG-Tetra Parallel Meshing Plug-in Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>MG-Tetra Parallel Meshing Plug-in Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/GHS3DPRLPLUGIN/index.html">User's Guide</a></big>
-<br><br><br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>GMSH Meshing Plug-in Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>GMSH Meshing Plug-in Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/GMSHPLUGIN/index.html">User's Guide</a></big>
-<br><br><br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2014-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>GUI Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>GUI Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/GUI/index.html">User's Guide</a></big>
-<br><br>
-<big><a href="tui/GUI/index.html">Developer Documentation</a></big>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>HELLO Sample Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>HELLO SAMPLE Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/HELLO/index.html">User's Guide</a></big>
-<br><br><br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>HEXABLOCK Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>HexaBlock Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/HEXABLOCK/index.html">User's Guide</a></big>
-<!--<br><br>
-<big><a href="tui/HEXABLOCK/index.html">Developer Documentation</a></big>-->
-<br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2009-2021 CEA/DEN, EDF R&D<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>HOMARD Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>Homard Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/HOMARD/en/index.html">Users Guide (English version)</a></big>
-<br><br>
-<big><a href="gui/HOMARD/fr/index.html">Users Guide (French version)</a></big>
-<br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2013-2021 CEA/DEN, EDF R&D<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>Hybrid Meshing Plug-in Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>Hybrid Meshing Plug-in Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/HYBRIDPLUGIN/index.html">User's Guide</a></big>
-<br><br><br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2014-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>MG-Hexa Meshing Plug-in Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>MG-Hexa Meshing Plug-in Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/HexoticPLUGIN/index.html">User's Guide</a></big>
-<br><br><br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>JOBMANAGER Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>JobManager Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/JOBMANAGER/index.html">User's Guide</a></big>
-<!--<br><br>
-<big><a href="tui/JOBMANAGER/index.html">Developer Documentation</a></big>-->
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2010-2021 CEA/DEN, EDF R&D<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>Kernel Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>Kernel Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="tui/KERNEL/index.html">Developer Documentation</a></big>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>Netgen Meshing Plug-in Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>Netgen Meshing Plug-in Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/NETGENPLUGIN/index.html">User's Guide</a></big>
-<br><br><br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>Post-Pro Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>PARAVIS Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="dev/PARAVIS/index.html">Developer Documentation</a></big>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>PYHELLO Sample Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>PYHELLO SAMPLE Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/PYHELLO/index.html">User's Guide</a></big>
-<br><br><br><br>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>Shaper Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>Shaper Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/SHAPER/index.html">User's Guide</a></big>
-<br><br>
-<big><a href="tui/SHAPER/index.html">Developer Documentation</a></big>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2014-2021 CEA/DEN, EDF R&D<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>Mesh Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>Mesh Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/SMESH/index.html">User's Guide</a></big>
-<br><br>
-<big><a href="tui/SMESH/index.html">Developer Documentation</a></big>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en"><html><head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]"><title>YACS Module Documentation</title></head>
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border=0>
-</div>
-
-<div align="center">
-<h1>YACS Module Documentation</h1>
-</div>
-
-<div align="center">
-<p><img src="about.png" alt="about.png"></p>
-<br><br>
-<big><a href="gui/YACS/index.html">User's Guide</a></big>
-<br><br>
-<big><a href="tui/YACS/index.html">Developer Documentation</a></big>
-</div>
-<br><br><br><br><br><br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
-Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
-Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
-
-
--- /dev/null
+# ==============================================================================
+# 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()
--- /dev/null
+<!DOCTYPE html>
+<head>
+ <title>Documentation is not build!</title>
+</head>
+<body>
+This documentation has not been built!
+</body>
+</html>
#
# 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()
-This directory contains Extra developer documentation by modules.
+This directory contains extra developer documentation.
# 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)
# 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)
--- /dev/null
+# 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()
# 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})
# 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()
+++ /dev/null
-This directory contains User's Guide documentation by modules.
+++ /dev/null
-<!DOCTYPE doctype PUBLIC "-//w3c//dtd html 4.0 transitional//en">
-<html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <meta name="GENERATOR" content="Mozilla/4.73 [en] (WinNT; I) [Netscape]">
-
-<title>SALOME Developer Documentation</title>
-
-<style type="text/css">
- .descr {
- font-size: 15px;
- font-family: Arial, Helvetica, sans-serif;
- }
- table.index {
- padding: 5px;
- border-spacing: 50px 20px;
- font-size: 15px;
- font-family: Arial, Helvetica, sans-serif;
- border: 0px solid;
- }
- th {
- color: #175783;
- border-bottom: 3px solid;
- font-size: 20px;
- }
-</style>
-</head>
-
-<body bgcolor="#ffffff" text="#000000" link="#0000ee" alink="#0000ee" vlink="#551a8b">
-
-<div style="text-align: left; background-color: #175783; border: 1px solid; height: 80px; background-repeat: no-repeat; margin-bottom: 10px;">
- <img src="head.png" border="0">
-</div>
-
-<div align="center">
- <h1>Developer's Documentation</h1>
-</div>
-
- <h4>Architecture</h4>
- <ul>
- <li>
- <a href="extra/SALOME_GUI_Architecture.pdf"><img src="pdf.png" border="0" width="16" height="16" /></a>
- <a href="extra/SALOME_GUI_Architecture.pdf">SALOME GUI Architecture (PDF, 1 MB)</a>
- <img src="warn.png" border="0" width="16" height="16" />
- </li>
- </ul>
-
- <h4>Module Development</h4>
- <ul>
- <li>See <a href="#SALOME_Tutorial">SALOME Tutorial</a></li>
- <li>
- <a href="extra/DumpPython_Extension.pdf"><img src="pdf.png" border="0" width="16" height="16" /></a>
- <a href="extra/DumpPython_Extension.pdf">Implement Dump Python (PDF, 67 KB)</a>
- </li>
- </ul>
-
- <h4>Mesh</h4>
- <ul>
- <li>
- <a href="extra/SALOME_4.1.2_SMDS_reference_guide.pdf"><img src="pdf.png" border="0" width="16" height="16" /></a>
- <a href="extra/SALOME_4.1.2_SMDS_reference_guide.pdf">Use of SMDS API (PDF, 416 KB)</a>
- <img src="warn.png" border="0" width="16" height="16" />
- </li>
- <li>
- <a href="extra/SALOME_Mesh_Plugins.pdf"><img src="pdf.png" border="0" width="16" height="16" /></a>
- <a href="extra/SALOME_Mesh_Plugins.pdf">Integration of new meshing algorithm as plug-in to SALOME Mesh module (PDF, 91 KB)</a>
- </li>
- </ul>
-
- <h4>Code Coupling</h4>
- <ul>
- <li>
- <a href="extra/Normalisation_pour_le_couplage_de_codes.pdf"><img src="pdf.png" border="0" width="16" height="16" /></a>
- <a href="extra/Normalisation_pour_le_couplage_de_codes.pdf">Normalisation des maillages et des champs pour le couplage (PDF, 1 MB)</a>
- <img src="fr.png" border="0" width="24" height="16" />
- </li>
- <li>
- <a href="extra/Interface_for_Code_Coupling.pdf"><img src="pdf.png" border="0" width="16" height="16" /></a>
- <a href="extra/Interface_for_Code_Coupling.pdf">Documentation of the Interface for Code Coupling / ICoCo (PDF, 1.6 MB)</a>
- <img src="fr.png" border="0" width="24" height="16" />
- </li>
- <li>
- <a href="extra/Couplage_de_codes_paralleles.pdf"><img src="pdf.png" border="0" width="16" height="16" /></a>
- <a href="extra/Couplage_de_codes_paralleles.pdf">Le couplage de codes paralleles dans la plateforme SALOME (PDF, 589 KB)</a>
- <img src="fr.png" border="0" width="24" height="16" />
- </li>
- <li>
- <a href="extra/Demonstrateur_couplage_fluide_structure_EDF.pdf"><img src="pdf.png" border="0" width="16" height="16" /></a>
- <a href="extra/Demonstrateur_couplage_fluide_structure_EDF.pdf">Démonstrateur couplage fluide structure EDF (PDF, 1.2 MB)</a>
- <img src="fr.png" border="0" width="24" height="16" />
- </li>
- </ul>
-
- <h4>Installation procedure</h4>
- <ul>
- <li><a href="dev/cmake/html/index.html">Build procedure (CMake)</a></li>
- </ul>
-
- <h4>Development</h4>
- <ul>
- <li><a href="dev/git/html/Git_Simple_Write_Procedure.html">Contributing to the SALOME project with Git</a></li>
- </ul>
-
-<table>
- <tr>
- <td colspan=2><hr/></td>
- </tr>
- <tr>
- <td width="30" align="center"><img src="warn.png" border="0" width="16" height="16" /></td>
- <td><i class="descr"> = Document is not up to date</i></td>
- </tr>
- <tr>
- <td width="30" align="center"><img src="fr.png" border="0" width="24" height="16" /></td>
- <td><i class="descr"> = Document in French</i></td>
- </tr>
-</table>
-
-<br>
-<hr />
-<a name="SALOME_Tutorial" />
-<h3>SALOME Tutorial</h3>
-<p class="descr">
- 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.<br />
- The tutorial can be downloaded from <a href="http://salome-platform.org/downloads">SALOME site</a>.
-</p>
-
-<br><br>
-<div style="text-align: center; background-color: #D9f4fd; border: 1px solid #AAAAAA; font-family: Arial, Helvetica, sans-serif; font-size: 11px; padding: 10px; margin-top: 15px;">
- Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE<br>
- Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS<br>
-</div>
-
-</body>
-</html>
--- /dev/null
+# 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
+#
+
+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})
--- /dev/null
+# -*- 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'2012-2021 CEA/DEN, EDF R&D, 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
+# "<project> v<release> 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 <link> 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'
--- /dev/null
+.. _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>`__
--- /dev/null
+.. _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
+
--- /dev/null
+.. _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 <https://www.salome-platform.org/downloads>`__.
+
+* |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>`__
--- /dev/null
+# 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
+#
+
+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})
--- /dev/null
+# -*- 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'2012-2021 CEA/DEN, EDF R&D, 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
+# "<project> v<release> 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 <link> 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'
--- /dev/null
+.. _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
--- /dev/null
+.. _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 <https://www.salome-platform.org/downloads>`__.
+
+* |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>`__
# 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()
+++ /dev/null
-This directory contains Developer documentation by modules.
