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