source: palm/trunk/SCRIPTS/generate_documentation @ 2011

Last change on this file since 2011 was 1758, checked in by maronga, 9 years ago

last commit documented

  • Property svn:executable set to *
File size: 2.5 KB
RevLine 
[1714]1#!/bin/bash
2#--------------------------------------------------------------------------------#
3# This file is part of PALM.
4#
5# PALM is free software: you can redistribute it and/or modify it under the terms
6# of the GNU General Public License as published by the Free Software Foundation,
7# either version 3 of the License, or (at your option) any later version.
8#
9# PALM is distributed in the hope that it will be useful, but WITHOUT ANY
10# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
12#
13# You should have received a copy of the GNU General Public License along with
14# PALM. If not, see <http://www.gnu.org/licenses/>.
15#
16# Copyright 1997-2014  Leibniz Universitaet Hannover
17#--------------------------------------------------------------------------------#
18#
19# Current revisions:
20# ------------------
21#
[1758]22#
[1714]23# Former revisions:
24# -----------------
25# $Id: $
26#
[1758]27#
28# Initial revision
29#
[1714]30#--------------------------------------------------------------------------------#
31# generate_documentation - script for generating the PALM code documentation
32#--------------------------------------------------------------------------------#
33
34echo "Generating PALM source code documentation..."
35
36# Checking if the environment variable PALM_BIN is set.
37if [[ -z $PALM_BIN ]]; then
38   echo "PALM_BIN is not set."
39   exit 1
40fi
41
[1715]42doc_dir=$PALM_BIN/../../documentation
43
[1714]44# Checking for doxygen
45if type -t doxygen; then
46
47   # Removing old documentation
[1715]48   if [[ -d $doc_dir ]];then
[1714]49      echo "Remove old documentation"
[1715]50      rm -r $doc_dir
[1714]51   fi
52   # Generating HTML documentation
53   echo "found doxygen. Continuing..."
54   cd $PALM_BIN/../DOC
55   doxygen palm2doxygen.config
56   if [[ $? -ne 0 ]];then
57      echo "doxygen detected an error."
58      exit 1
59   fi
[1715]60   cd $doc_dir
61   doc_dir=$(pwd)
[1714]62   ln -s $(pwd)/html/index.html PALM_doc.html
63   echo "HTML source code documentation generated."
64   
65   # Checking for pdflatex
66   if type -t pdflatex; then
67   
68      # Generating PDF documentation
[1715]69      cd $doc_dir/latex
[1714]70      make pdf
[1715]71      cd $doc_dir
[1714]72      ln -s $(pwd)/latex/refman.pdf PALM_doc.pdf
73      echo "PDF source code documentation generated."
74   
75   else
76      echo "ERROR: pdflatex not found."
77      echo "Skipping PDF documentation generation. Terminating!"
78      exit 1
79   fi
80else
81   echo "ERROR: doxygen not found."
82   echo "Skipping PALM documentation generation. Terminating!"
83   exit 1
84fi
85
[1715]86echo "The PALM source code documentation is located in: $doc_dir"
87echo "Done."
Note: See TracBrowser for help on using the repository browser.