]> git.street.me.uk Git - andy/viking.git/blob - doc/reference/README
Detail on how to regenerate reference help
[andy/viking.git] / doc / reference / README
1 In order to activate reference documentation, you have to specify
2 the following configure command line:
3 $ ./configure --enable-gtk-doc --enable-gtk-doc-html
4
5 Then, cd to doc/reference and launch make command.
6
7 (This directory is not recursively make when launching make from top
8 directory. So, this avoid spending time in reference documentation
9 computation when not really needed.)
10
11 Unfortunately to regenerate the references running make again does not
12 detect any changes to the source files, thus it must be regenerated
13 manually:
14
15 $ make clean ; make
16
17 If you want remove the generated HTML files you need to perform a more
18 thorough cleanse:
19
20 $ make distclean
21
22 Unfortunately this also removes the Makefile, so you have to go through
23 the ./configure steps again to regenerate the Makefile.
24