some summary functions work
[pspp] / doc / prepdoc.sh
1 #! /bin/bash -x
2
3 # This is a short preparation script to create dummy
4 # files for running makeinfo if you want to work on
5 # the documentation without having a full build environment
6 # for pspp.
7 # You need to have makeinfo available on the shell which
8 # is provided by the texinfo package.
9 # Then you can create the html version of the documentation
10 # with:
11 #
12 # makeinfo --html pspp.texi
13 #
14 # This will create all hmtl files in the new directory pspp.
15 #
16 # Then you can view the documentation with:
17 #
18 # open pspp/index.html
19 #
20 # That will open your webbrowser and you can see the documentation
21
22 ## Here are the three texi files which are normally generated during
23 ## the build process.
24
25 # Create version.texi
26 echo "@set UPDATED 13 April 2020" > version.texi
27 echo "@set UPDATED-MONTH April 2020" >> version.texi
28 echo "@set EDITION 1.3.0-g90731b37a" >> version.texi
29 echo "@set VERSION 1.3.0-g90731b37a" >> version.texi
30
31 #Create tut.texi
32 echo "@set example-dir ../../examples" > tut.texi
33
34 #Create ni.texi
35 echo "@table @asis" > ni.texi
36 echo "@item @cmd{2SLS}" >> ni.texi
37 echo "This is just an example for missing items." >> ni.texi
38 echo "@end table" >> ni.texi
39
40