summaryrefslogtreecommitdiff
path: root/muse2/doc/build_docs.sh
blob: 0ae0840ccc05374bac99f67f8747d6bcd9ab7690 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
#!/bin/bash
#=============================================================================
#  MusE
#  Linux Music Editor
#  Copyright (C) 1999-2013 by Werner Schweer and others
#
#  build_docs.sh Copyright (C) 2013 Tim E. Real <terminator356 at users dot sourceforge dot net>
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License
#  as published by the Free Software Foundation; either version 2
#  of the License, or (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program; if not, write to the
#  Free Software Foundation, Inc.,
#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#=============================================================================

#=============================================================
#
# Run this script to re-create the PDF and HTML documentation.
# Usage: build_docs.sh [--help] [--no_post_clean]
#
#=============================================================

if [ "$1" == "--help" ]; then
        echo "Usage: build_docs.sh [--no_post_clean (don't clean up after build)]"
        exit 1
fi

#
# Pre clean
#
rm -rf pdf/*.*
rm -rf html/single/documentation/*.*
rm -rf html/single/developer_docs/*.*
rm -rf html/split/documentation/*.*
rm -rf html/split/developer_docs/*.*
rm -rf tmp

mkdir -p tmp/pdf/documentation
mkdir -p tmp/pdf/developer_docs

mkdir -p tmp/html/single/documentation
mkdir -p tmp/html/single/developer_docs
mkdir -p tmp/html/split/documentation
mkdir -p tmp/html/split/developer_docs

#
# Run the PDF conversions first to get the *.aux files required for proper HTML links displaying
# Run each conversion at least three times to resolve all references
#
pdflatex -interaction=batchmode -halt-on-error -file-line-error -output-directory=tmp/pdf/documentation documentation.tex
pdflatex -interaction=batchmode -halt-on-error -file-line-error -output-directory=tmp/pdf/documentation documentation.tex
pdflatex -interaction=batchmode -halt-on-error -file-line-error -output-directory=tmp/pdf/documentation documentation.tex

pdflatex -interaction=batchmode -halt-on-error -file-line-error -output-directory=tmp/pdf/developer_docs developer_docs.tex
pdflatex -interaction=batchmode -halt-on-error -file-line-error -output-directory=tmp/pdf/developer_docs developer_docs.tex
pdflatex -interaction=batchmode -halt-on-error -file-line-error -output-directory=tmp/pdf/developer_docs developer_docs.tex

#
# Now run the HTML conversions
#
latex2html -nonavigation -noaddress -noinfo -split 0 -external_file tmp/pdf/documentation/documentation -mkdir -dir tmp/html/single/documentation documentation.tex
latex2html -nonavigation -noaddress -noinfo -split 0 -external_file tmp/pdf/developer_docs/developer_docs -mkdir -dir tmp/html/single/developer_docs developer_docs.tex
latex2html -noaddress -noinfo -split 4 -external_file tmp/pdf/documentation/documentation -mkdir -dir tmp/html/split/documentation documentation.tex
latex2html -noaddress -noinfo -split 4 -external_file tmp/pdf/developer_docs/developer_docs -mkdir -dir tmp/html/split/developer_docs developer_docs.tex

#
# Move the files
#
mv -f tmp/pdf/documentation/*.pdf pdf
mv -f tmp/pdf/developer_docs/*.pdf pdf

mv -f tmp/html/single/documentation/*.css   html/single/documentation
mv -f tmp/html/single/documentation/*.html  html/single/documentation
# mv -f tmp/html/single/documentation/*.jpg   html/single/documentation
mv -f tmp/html/single/documentation/*.png   html/single/documentation
# mv -f tmp/html/single/documentation/toc_.txt html/single/documentation

mv -f tmp/html/single/developer_docs/*.css   html/single/developer_docs
mv -f tmp/html/single/developer_docs/*.html  html/single/developer_docs
# mv -f tmp/html/single/developer_docs/*.jpg   html/single/developer_docs
mv -f tmp/html/single/developer_docs/*.png   html/single/developer_docs
# mv -f tmp/html/single/developer_docs/toc_.txt html/single/developer_docs

mv -f tmp/html/split/documentation/*.css    html/split/documentation
mv -f tmp/html/split/documentation/*.html   html/split/documentation
# mv -f tmp/html/split/documentation/*.jpg    html/split/documentation
mv -f tmp/html/split/documentation/*.png    html/split/documentation
# mv -f tmp/html/split/documentation/toc_.txt html/split/documentation

mv -f tmp/html/split/developer_docs/*.css    html/split/developer_docs
mv -f tmp/html/split/developer_docs/*.html   html/split/developer_docs
# mv -f tmp/html/split/developer_docs/*.jpg    html/split/developer_docs
mv -f tmp/html/split/developer_docs/*.png    html/split/developer_docs
# mv -f tmp/html/split/developer_docs/toc_.txt html/split/developer_docs

#
# Post clean
#
if [ "$1" != "--no_post_clean" ]; then
rm -rf tmp
fi