src/Tools/padder/doc/Makefile.am

   1 # Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19
  20 #  Author : Guillaume Boulant (EDF/R&D)
  21
  22 include $(top_srcdir)/adm_local/unix/make_common_starter.am
  23
  24 EXTRA_DIST += images input
  25
  26 #
  27 # The simplest way to extends the documentation of SMESH with the
  28 # documentation for PADDER is to copy the local source files (*.doc
  29 # and *.png) in the source directory of SMESH documentation. Theses
  30 # pages will be automagically included in the SMESH documentation
  31 # generating process (make usr_docs executed at installation step) and
  32 # will be inserted in the page pages.html that lists the "Related
  33 # pages".
  34 #
  35
  36 DOC_FILES = \
  37         padder_userguide.doc
  38
  39 DOCDIR=$(top_srcdir)/doc/salome/gui/SMESH/input
  40
  41 IMG_FILES = \
  42         SMESH_spadder_end.png                            \
  43         SMESH_spadder_inputdialog_concrete.png           \
  44         SMESH_spadder_inputdialog_start.png              \
  45         SMESH_spadder_inputdialog_steelbar.png           \
  46         SMESH_spadder_menu.png                           \
  47         SMESH_spadder_plugindialog_compute_finished.png  \
  48         SMESH_spadder_plugindialog_compute_ready.png     \
  49         SMESH_spadder_plugindialog_compute_running.png   \
  50         SMESH_spadder_plugindialog_published.png         \
  51         SMESH_spadder_plugindialog_start.png             \
  52         SMESH_spadder_start.png
  53
  54
  55 IMGDIR=$(top_srcdir)/doc/salome/gui/SMESH/images
  56
  57
  58 all:
  59         @mkdir -p $(DOCDIR); \
  60         for docfile in $(DOC_FILES); do  \
  61             if [ ! -h $(DOCDIR)/$${docfile} ]; then \
  62                 echo "Linking file $${docfile} to $(DOCDIR)/$${docfile}"; \
  63                 ln -s ../$(srcdir)/input/$${docfile} $(DOCDIR)/$${docfile}; \
  64             fi; \
  65         done; \
  66         for imgfile in $(IMG_FILES); do  \
  67             if [ ! -h $(IMGDIR)/$${imgfile} ]; then \
  68                 echo "Linking file $${imgfile} to $(IMGDIR)/$${imgfile}"; \
  69                 ln -s ../$(srcdir)/images/$${imgfile} $(IMGDIR)/$${imgfile}; \
  70             fi; \
  71         done;
  72
  73 clean-local:
  74         @ls | grep -v -e Makefile -e doxyfile | xargs rm -rf; \
  75         for docfile in $(DOC_FILES); do  \
  76             echo "Removing file $${docfile} from $(DOCDIR)"; \
  77             rm $(DOCDIR)/$${docfile}; \
  78         done; \
  79         for imgfile in $(IMG_FILES); do  \
  80             echo "Removing file $${imgfile} from $(IMGDIR)"; \
  81             rm $(IMGDIR)/$${imgfile}; \
  82         done;
  83
  84 #
  85 # For test purpose, we let the user generate a local dosygen
  86 # documentation including only the local pages
  87 #
  88 test_docs: doxyfile
  89         echo "===========================================" ; \
  90         echo "Generating PADDER documentation" ;             \
  91         echo "===========================================" ; \
  92         $(DOXYGEN) doxyfile ;