README

   1
   2 GTK+ DocBook Documentation Generator
   3 ====================================
   4
   5 GTK-Doc is used to document C code. It is typically used to document the public
   6 API of libraries, such as the GTK+ and GNOME libraries, but it can also be
   7 used to document application code.
   8
   9 Note that GTK-Doc wasn't originally intended to be a general-purpose
  10 documentation tool, so it can be a bit awkward to setup and use.
  11 For a more polished general-purpose documentation tool you may want to look
  12 at Doxygen (http://www.doxygen.org/). However GTK-Doc has some special code
  13 to document the signals and properties of GTK+ widgets and GObject classes
  14 which other tools may not have.
  15
  16 From your source code comments GTK-Doc generates a Docbook XML document, which
  17 is then transformed into HTML and/or PDF.
  18 The generated HTML documentation can be browsed in an ordinary web browser or
  19 by using the special Devhelp API browser
  20 (see http://developer.imendio.com/wiki/Devhelp).
  21
  22 Please use DoxBook XML instead of DocBook SGML - support for the later will be
  23 dropped.
  24
  25 Requirements
  26 ============
  27
  28 Python 2.7, 3.x - the secondary scripts are written in Python
  29     http:///www.python.org
  30
  31 Python-six - for python 2,3 compatibility
  32
  33 For XML output (recommended):
  34
  35 The DocBook XML DTD.
  36     http://www.oasis-open.org/docbook/
  37
  38 The DocBook XSL Stylesheets.
  39     http://docbook.sourceforge.net/projects/xsl/
  40
  41 libxslt & libxml2 >= 2.3.6.
  42     http://xmlsoft.org/
  43
  44
  45 Most distributions now have packages for all of these, so I would strongly
  46 advise that you grab those.
  47
  48 See the documentation in the help/manual directory for more information. You can
  49 read it e.g. with yelp file://$PWD/help/manual/C/gtk-doc-manual.xml