gtk/docs/reference
Matthias Clasen cedc3cb6e1 Hook up docs
2011-12-19 12:51:09 -05:00
..
gdk Tell gtk-doc about G_GNUC_WARN_UNUSED_RESULT 2011-12-19 07:32:32 -05:00
gtk Hook up docs 2011-12-19 12:51:09 -05:00
libgail-util Fix document generation in out of tree builds 2011-10-21 16:27:13 -04:00
AUTHORS Initial revision 1999-08-16 18:51:52 +00:00
ChangeLog Removed empty docs/reference/ChangeLog entries. I am using prepare-ChangeLog.pl to help create informative commit messages and this was a side-effect. 2009-07-16 18:13:34 +02:00
COPYING Initial revision 1999-08-16 18:51:52 +00:00
Makefile.am Keep building libgail-util docs for now 2011-07-22 19:52:54 -04:00
README Initial revision 1999-08-16 18:51:52 +00:00
README.cvs-commits Initial revision 1999-08-16 18:51:52 +00:00

This package contains the reference documentation
for GTK+. For more information about GTK+
see:

 http://www.gtk.org

For information about contributing to the
GLib/GTK+ reference documentation project, see:

 http://www.gtk.org/rdp/

The GTK+ reference documentation is freely redistributable,
see the file COPYING for details.


REQUIREMENTS
============

To build the documentation, you must have the gtk-doc
package installed. To rebuild the template files,
you must have the current version of the GTK+
header files installed.


BUILD
=====

First, run configure to generate the makefiles for this
module. There is one option specific to this package

  --with-html-dir=DIR   top of installed HTML documentation tree


The Makefiles in the gdk/ and gtk/ subdirs each define three targets:

 templates:
  
  Scan the headers and merge the results with the current 
  template files

 sgml:

  Generate SGML files using the DocBook DTD from
  the template files

 html:

  Generate HTML from the SGML files.

To build the documentation, do:

 make sgml
 make html

You should only run the 'make templates' step if you
need to regenerate the templates for a more recent
version of the GTK+ sources.

INSTALLATION
============

 make install