-Some edit of user's documentation

Improve make dev_docs step:
- It does not install anything; only generates output with doxygen
- make install installs output files generated by make dev_docs
- make clean cleans generated files-

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 23d05662e09b99b441ab57aee6fa664377f3ce04..99f781e13ca41ee5ad9c4a97eca82718681e2ec1 100644 (file)
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -19,15 +19,6 @@
 
 INCLUDE(${KERNEL_ROOT_DIR}/salome_adm/cmake_files/SalomeMacros.cmake)
 
-SET(top_builddir ${CMAKE_BINARY_DIR})
-SET(top_srcdir ${CMAKE_SOURCE_DIR})
-SET(srcdir ${CMAKE_CURRENT_SOURCE_DIR})
-SET(builddir ${CMAKE_CURRENT_BINARY_DIR})
-SET(datadir ${CMAKE_INSTALL_PREFIX}/share)
-SET(docdir ${datadir}/doc/salome)
-SET(yacsdocdir ${docdir}/gui/YACS)
-SET(yacsdevdocdir ${docdir}/tui/YACS)
-
 SET(RSTFILES
   accesCorba.rst
   accesLocal.rst
@@ -74,36 +65,43 @@ SET(RSTFILES
   )
 
 SET(SPHINXOPTS )
-SET(SOURCEDIR ${srcdir})
+SET(SOURCEDIR ${CMAKE_CURRENT_SOURCE_DIR})
 SET(PAPEROPT_a4 -D latex_paper_size=a4)
 SET(ALLSPHINXOPTS -d doctrees ${PAPEROPT_a4} ${SPHINXOPTS} ${SOURCEDIR})
 
-SALOME_CONFIGURE_FILE(Doxyfile.in Doxyfile)
+# install user's documentation
+
 SALOME_CONFIGURE_FILE(conf.py.in conf.py)
-SALOME_CONFIGURE_FILE(sources/header.html.in sources/header.html)
 
-# install user's documentation
 ADD_CUSTOM_TARGET(htm 
-  COMMAND mkdir -p html doctrees
-  COMMAND ${SPHINX_EXECUTABLE} -c ${top_builddir}/doc -b html ${ALLSPHINXOPTS} html
+  COMMAND ${CMAKE_COMMAND} -E make_directory html 
+  COMMAND ${CMAKE_COMMAND} -E make_directory doctrees
+  COMMAND ${SPHINX_EXECUTABLE} -c ${CMAKE_BINARY_DIR}/doc -b html ${ALLSPHINXOPTS} html
   DEPENDS ${RSTFILES}
   WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
   )
 INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target htm)")
 INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ 
-  DESTINATION ${yacsdocdir} 
+  DESTINATION ${SALOME_INSTALL_DOC}/gui/YACS 
   USE_SOURCE_PERMISSIONS
   PATTERN ".buildinfo" EXCLUDE
   )
+  
+SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES html)
+SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES doctrees)
 
 # install developer's documentation
-ADD_CUSTOM_TARGET(dev_docs
-  COMMAND ${DOXYGEN_EXECUTABLE} -u
-  COMMAND ${DOXYGEN_EXECUTABLE}
-  COMMAND mkdir -p ${yacsdevdocdir}
-  COMMAND cp -fv ${srcdir}/images/head.png ${yacsdevdocdir}/head.png
-  COMMAND find "${builddir}/htmldev" -name \"*.*\" -exec cp -rfv {} ${yacsdevdocdir} '\;'
-  COMMAND cp -rfv ${top_srcdir}/src/yacsloader/samples ${yacsdevdocdir}
-  COMMAND rm -rf ${yacsdevdocdir}/samples/CVS
-  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-  )
+
+SALOME_CONFIGURE_FILE(Doxyfile.in Doxyfile)
+SALOME_CONFIGURE_FILE(sources/header.html.in sources/header.html)
+
+ADD_CUSTOM_TARGET(dev_docs ${DOXYGEN_EXECUTABLE})
+
+INSTALL(CODE "FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/YACS/htmldev)")
+INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/YACS/htmldev/ DESTINATION ${SALOME_INSTALL_DOC}/tui/YACS)
+INSTALL(FILES images/head.png DESTINATION ${SALOME_INSTALL_DOC}/tui/YACS) 
+INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/yacsloader/samples 
+        DESTINATION ${SALOME_INSTALL_DOC}/tui/YACS
+        PATTERN "CVS" EXCLUDE
+        )  
+SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES YACS)

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 4b815adc6d51cf571e888cfd5adc6abd06896a38..097d16d636c471b83511d832dee7e0857ec791b6 100644 (file)
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -24,7 +24,7 @@
 #
 PROJECT_NAME           = YACS
 PROJECT_NUMBER         = 0.1
-OUTPUT_DIRECTORY       = .
+OUTPUT_DIRECTORY       = YACS
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 USE_WINDOWS_ENCODING   = NO
@@ -101,19 +101,19 @@ WARN_LOGFILE           =
 # configuration options related to the input files
 #---------------------------------------------------------------------------
 INPUT                  =  \
-   @top_srcdir@/doc/ref      \
-   @top_srcdir@/idl \
-   @top_srcdir@/src/bases \
-   @top_srcdir@/src/engine \
-   @top_srcdir@/src/runtime \
-   @top_srcdir@/src/yacsloader \
-   @top_srcdir@/src/yacsorb \
-   @top_srcdir@/src/hmi \
-   @top_srcdir@/src/salomewrap \
-   @top_srcdir@/src/genericgui \
-   @top_srcdir@/src/salomegui \
-   @top_srcdir@/src/salomewrap \
-   @top_srcdir@/src/pyqt
+   @CMAKE_SOURCE_DIR@/doc/ref      \
+   @CMAKE_SOURCE_DIR@/idl \
+   @CMAKE_SOURCE_DIR@/src/bases \
+   @CMAKE_SOURCE_DIR@/src/engine \
+   @CMAKE_SOURCE_DIR@/src/runtime \
+   @CMAKE_SOURCE_DIR@/src/yacsloader \
+   @CMAKE_SOURCE_DIR@/src/yacsorb \
+   @CMAKE_SOURCE_DIR@/src/hmi \
+   @CMAKE_SOURCE_DIR@/src/salomewrap \
+   @CMAKE_SOURCE_DIR@/src/genericgui \
+   @CMAKE_SOURCE_DIR@/src/salomegui \
+   @CMAKE_SOURCE_DIR@/src/salomewrap \
+   @CMAKE_SOURCE_DIR@/src/pyqt
 
 FILE_PATTERNS          = *.c \
                          *.cc \
@@ -156,13 +156,13 @@ FILE_PATTERNS          = *.c \
                          *.M \
                          *.MM
 RECURSIVE              = YES
-EXCLUDE                = @top_srcdir@/src/yacsloader/tools 
+EXCLUDE                = @CMAKE_SOURCE_DIR@/src/yacsloader/tools 
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       = */Test/*
 EXAMPLE_PATH           = 
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             = @top_srcdir@/doc
+IMAGE_PATH             = @CMAKE_SOURCE_DIR@/doc
 INPUT_FILTER           = 
 FILTER_PATTERNS        = 
 FILTER_SOURCE_FILES    = NO
@@ -187,9 +187,9 @@ IGNORE_PREFIX          =
 GENERATE_HTML          = YES
 HTML_OUTPUT            = htmldev
 HTML_FILE_EXTENSION    = .html
-HTML_HEADER            = @builddir@/sources/header.html
-HTML_FOOTER            = @srcdir@/sources/footer.html
-HTML_EXTRA_STYLESHEET  = @srcdir@/sources/salome_extra.css
+HTML_HEADER            = @CMAKE_CURRENT_BINARY_DIR@/sources/header.html
+HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/sources/footer.html
+HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/sources/salome_extra.css
 HTML_ALIGN_MEMBERS     = YES
 GENERATE_HTMLHELP      = NO
 CHM_FILE               =