doc/txt2html.sh

   1 #/bin/sh
   2 # ===================================================================
   3 # This shell script is provided for generating the html files
   4 # from the txt files (restructured text) in the source directory.
   5 #
   6 # Usage: just execute the script where it stands in the source
   7 # directory. The file list has to be updated manually when adding
   8 # a new restructured text file.
   9 #
  10 # Note that the building process executes a target rstdoc that
  11 # generates the html documentation without need of this script.
  12 # The autoconficuration (check_htmlgen.m4) set the correct generator
  13 # rst2html by replacing the @RST2HTML@ tag.
  14 # ===================================================================
  15 # (CSSI - gboulant - 25/10/05)
  16 #
  17
  18 # This must be updated manually in this script (for source usage only)
  19 RST2HTML=rst2html
  20
  21 FILELIST="index
  22           UnitTests
  23           SALOME_Application
  24           INSTALL
  25           kernel_resources
  26           userguide"
  27
  28 STYLESHEET=rst.css
  29 RSTOPTS="--output-encoding=latin1 --stylesheet=$STYLESHEET"
  30
  31 for file in $FILELIST; do
  32     bfn=`basename $file .txt`
  33     echo "Generating ${bfn}.html from ${bfn}.txt ..."
  34     $RST2HTML $RSTOPTS ${bfn}.txt ${bfn}.html
  35 done
  36