[go: up one dir, main page]

Menu

Tree [32ec18] master / doc / reference /
 History

HTTPS access


File Date Author Commit
 Makefile.am 2021-09-11 Rob Norris Rob Norris [6ca3b0] autoconf obsolescence improvements
 README 2012-10-07 Rob Norris Rob Norris [649faa] Detail on how to regenerate reference help

Read Me

In order to activate reference documentation, you have to specify
the following configure command line:
$ ./configure --enable-gtk-doc --enable-gtk-doc-html

Then, cd to doc/reference and launch make command.

(This directory is not recursively make when launching make from top
directory. So, this avoid spending time in reference documentation
computation when not really needed.)

Unfortunately to regenerate the references running make again does not
detect any changes to the source files, thus it must be regenerated
manually:

$ make clean ; make

If you want remove the generated HTML files you need to perform a more
thorough cleanse:

$ make distclean

Unfortunately this also removes the Makefile, so you have to go through
the ./configure steps again to regenerate the Makefile.