doc/txt2html.sh

   1 #  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 #  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 #  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 #
   6 #  This library is free software; you can redistribute it and/or
   7 #  modify it under the terms of the GNU Lesser General Public
   8 #  License as published by the Free Software Foundation; either
   9 #  version 2.1 of the License.
  10 #
  11 #  This library is distributed in the hope that it will be useful,
  12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 #  Lesser General Public License for more details.
  15 #
  16 #  You should have received a copy of the GNU Lesser General Public
  17 #  License along with this library; if not, write to the Free Software
  18 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 #
  20 #  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 #
  22 #/bin/sh
  23 # ===================================================================
  24 # This shell script is provided for generating the html files
  25 # from the txt files (restructured text) in the source directory.
  26 # Usage: just execute the script where it stands in the source
  27 # directory. The file list has to be updated manually when adding
  28 # a new restructured text file.
  29 # Note that the building process executes a target rstdoc that
  30 # generates the html documentation without need of this script.
  31 # The autoconficuration (check_htmlgen.m4) set the correct generator
  32 # rst2html by replacing the @RST2HTML@ tag.
  33 # ===================================================================
  34 # (CSSI - gboulant - 25/10/05)
  35 # This must be updated manually in this script (for source usage only)
  36 #
  37 RST2HTML=rst2html
  38
  39 FILELIST="index
  40           UnitTests
  41           SALOME_Application
  42           INSTALL
  43           kernel_resources
  44           userguide"
  45
  46 STYLESHEET=rst.css
  47 RSTOPTS="--output-encoding=latin1 --stylesheet=$STYLESHEET"
  48
  49 for file in $FILELIST; do
  50     bfn=`basename $file .txt`
  51     echo "Generating ${bfn}.html from ${bfn}.txt ..."
  52     $RST2HTML $RSTOPTS ${bfn}.txt ${bfn}.html
  53 done
  54