doc/txt2html.sh

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