Redesign SALOME documentation

diff --git a/doc/salome/CMakeLists.txt b/doc/salome/CMakeLists.txt
index 19b17caff35047d4d37fed36bbac87820e0b4d08..f93f6886049ea9f5fd796909a2133e5d50b15352 100755 (executable)
--- a/doc/salome/CMakeLists.txt
+++ b/doc/salome/CMakeLists.txt
@@ -17,5 +17,4 @@
 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 #
 
-ADD_SUBDIRECTORY(gui)
 ADD_SUBDIRECTORY(tui)
\ No newline at end of file

diff --git a/doc/salome/main.dox b/doc/salome/main.dox
index e89060e3424e7d6a7bfdbc7bc45df5ec61eec88f..33458d1189e05c1707b1467112baafb100d0d924 100644 (file)
--- a/doc/salome/main.dox
+++ b/doc/salome/main.dox
@@ -63,5 +63,15 @@ specific points of %SALOME Kernel :
 - \subpage python_documentation : The package salome.kernel provides
   logging tools, high-level functions to handle items in Salome study, and other utilities.
 
+
+\section S6_main SALOME KERNEL module Developer Documentation
+
+To browse the \b SALOME KERNEL module Developer Documentation, follow the links below or use navigation menu at the top of the page:
+<ul>
+<li> <a href="namespaces.html">Namespaces</a> - list of KERNEL namespaces and scripts.</li>
+<li> <a href="annotated.html">Data Structures</a> - list of all data structures and classes with brief descriptions.</li>
+<li> <a href="files.html">Files</a> - list of all files with brief descriptions.</li>
+</ul>
+
 */
 

diff --git a/doc/salome/tui/CMakeLists.txt b/doc/salome/tui/CMakeLists.txt
index a2a99860263372137b0efdb8cf80c8364e031ba0..f295132cf3c2c00b5e9576edaa41dc648b61ab9b 100755 (executable)
--- a/doc/salome/tui/CMakeLists.txt
+++ b/doc/salome/tui/CMakeLists.txt
@@ -20,7 +20,37 @@
 SALOME_CONFIGURE_FILE(doxyfile.in doxyfile)
 SALOME_CONFIGURE_FILE(static/header.html.in static/header.html)
 
-ADD_CUSTOM_TARGET(dev_docs ${DOXYGEN_EXECUTABLE})
+SET(gen_doc "${CMAKE_SOURCE_DIR}/salome_adm/prepare_generating_doc.py")
+IF(WIN32)
+  STRING(REPLACE "/" "\\" gen_doc ${gen_doc})
+ENDIF(WIN32)
+SET(kernel_py ${CMAKE_SOURCE_DIR}/src/KERNEL_PY)
+
+ADD_CUSTOM_TARGET(dev_docs ${CMAKE_COMMAND} -E make_directory tmp
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/kernel.py ${kernel_py}/kernel/__init__.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/deprecation.py ${kernel_py}/kernel/deprecation.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/termcolor.py ${kernel_py}/kernel/termcolor.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/logger.py ${kernel_py}/kernel/logger.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/enumerate.py ${kernel_py}/kernel/enumerate.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/uiexception.py ${kernel_py}/kernel/uiexception.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/datamodeler.py ${kernel_py}/kernel/datamodeler.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/diclookup.py ${kernel_py}/kernel/diclookup.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/services.py ${kernel_py}/kernel/services.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/studyedit.py ${kernel_py}/kernel/studyedit.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/unittester.py ${kernel_py}/kernel/unittester.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/pyunittester.py ${kernel_py}/kernel/pyunittester.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/parametric.py ${kernel_py}/kernel/parametric/__init__.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/study_exchange_vars.py ${kernel_py}/kernel/parametric/study_exchange_vars.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/compo_utils.py ${kernel_py}/kernel/parametric/compo_utils.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/pyscript_utils.py ${kernel_py}/kernel/parametric/pyscript_utils.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/salome.py ${kernel_py}/__init__.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/salome_iapp.py ${kernel_py}/salome_iapp.py
+  COMMAND ${PYTHON_EXECUTABLE} ${gen_doc} -o tmp/SALOME_DriverPy.py ${CMAKE_SOURCE_DIR}/src/SALOMEDS/SALOME_DriverPy.py
+  COMMAND ${DOXYGEN_EXECUTABLE} doxyfile
+  COMMAND  ${CMAKE_COMMAND} -E remove_directory tmp
+  VERBATIM 
+  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}             
+)
 
 INSTALL(CODE "FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/KERNEL)")
 INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/KERNEL 
@@ -29,4 +59,6 @@ INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/KERNEL
        PATTERN "*.map" EXCLUDE)
 INSTALL(FILES ${CMAKE_CURRENT_SOURCE_DIR}/images/head.png DESTINATION ${SALOME_INSTALL_DOC}/tui/KERNEL)
 
+SET(MAKE_CLEAN_FILES KERNEL log.txt)
+
 SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES KERNEL)

diff --git a/doc/salome/tui/doxyfile.in b/doc/salome/tui/doxyfile.in
index 5b0e66757c4b36d19854a0f96a24665ccbadcf5e..72701edb69b46b21704902cbd8a5bcec10c84772 100644 (file)
--- a/doc/salome/tui/doxyfile.in
+++ b/doc/salome/tui/doxyfile.in
@@ -23,20 +23,20 @@
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
-PROJECT_NAME           = "SALOME KERNEL Developer"
-PROJECT_NUMBER         =
+PROJECT_NAME           = "SALOME KERNEL Reference Guide"
+PROJECT_NUMBER         = 
 OUTPUT_DIRECTORY       = KERNEL
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 USE_WINDOWS_ENCODING   = NO
 BRIEF_MEMBER_DESC      = YES
 REPEAT_BRIEF           = YES
-ABBREVIATE_BRIEF       =
+ABBREVIATE_BRIEF       = 
 ALWAYS_DETAILED_SEC    = YES
 INLINE_INHERITED_MEMB  = YES
 FULL_PATH_NAMES        = YES
-STRIP_FROM_PATH        = @PROJECT_SOURCE_DIR@ @PROJECT_BINARY_DIR@
-STRIP_FROM_INC_PATH    =
+STRIP_FROM_PATH        = @PROJECT_BINARY_DIR@ @PROJECT_SOURCE_DIR@
+STRIP_FROM_INC_PATH    = 
 SHORT_NAMES            = NO
 JAVADOC_AUTOBRIEF      = YES
 QT_AUTOBRIEF           = YES
@@ -45,7 +45,7 @@ DETAILS_AT_TOP         = NO
 INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 5
-ALIASES                =
+ALIASES                = 
 OPTIMIZE_OUTPUT_FOR_C  = YES
 OPTIMIZE_OUTPUT_JAVA   = YES
 BUILTIN_STL_SUPPORT    = @DOXYGEN_SUPPORT_STL@
@@ -96,17 +96,18 @@ WARN_LOGFILE           = log.txt
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = @PROJECT_SOURCE_DIR@/src \
+INPUT                  = @CMAKE_CURRENT_BINARY_DIR@/tmp \
+                        @PROJECT_SOURCE_DIR@/doc/salome \
+                        @PROJECT_SOURCE_DIR@/src \
                          @PROJECT_SOURCE_DIR@/bin \
                          @PROJECT_SOURCE_DIR@/idl \
                          @PROJECT_BINARY_DIR@/bin \
-                         @CMAKE_CURRENT_SOURCE_DIR@/input
-FILE_PATTERNS          = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc
+FILE_PATTERNS          = *.idl *.hxx *.cxx *.h *.c *.hh *.cc @DOXYGEN_PYTHON_EXTENSION@ *.doc *.dox
 RECURSIVE              = YES
 EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = @PROJECT_SOURCE_DIR@/doc/salome/examples
 EXAMPLE_PATTERNS       =
 EXAMPLE_RECURSIVE      = NO
 IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/images
@@ -129,8 +130,8 @@ VERBATIM_HEADERS       = YES
 # configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
 ALPHABETICAL_INDEX     = YES
-COLS_IN_ALPHA_INDEX    = 2
-IGNORE_PREFIX          =
+COLS_IN_ALPHA_INDEX    = 3
+IGNORE_PREFIX          = 
 
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output
@@ -252,7 +253,7 @@ DOT_FONTNAME           = Arial
 DOT_PATH               =
 DOTFILE_DIRS           =
 MAX_DOT_GRAPH_WIDTH    = 1024
-MAX_DOT_GRAPH_HEIGHT   = 1000
+MAX_DOT_GRAPH_HEIGHT   = 1200
 MAX_DOT_GRAPH_DEPTH    = 0
 DOT_TRANSPARENT        = NO
 DOT_MULTI_TARGETS      = NO
@@ -262,4 +263,4 @@ DOT_CLEANUP            = YES
 #---------------------------------------------------------------------------
 # Configuration::additions related to the search engine
 #---------------------------------------------------------------------------
-SEARCHENGINE           = NO
+SEARCHENGINE           = YES

diff --git a/doc/salome/tui/images/icon_about.png b/doc/salome/tui/images/icon_about.png
new file mode 100755 (executable)
index 0000000..61b9676
Binary files /dev/null and b/doc/salome/tui/images/icon_about.png differ