[[PageOutline(2-5,Contents,pullout)]]

= Integrate GTK-Doc documentation pages into Trac

== Description

This plugin integrates gtkdoc books into Trac's interface. This is accomplished by displaying the actual html output of gtkdoc, as well as integrating into the search engine in Trac. [https://wiki.gnome.org/DocumentationProject/GtkDoc GTK-Doc] generates API documentation from comments added to C code, but can also be used to document other application code such as Python.

This plugin implements the following new user permissions:
 * `GTKDOC_SEARCH`: search in the API documentation
 * `GTKDOC_VIEW`: view the API documentation
 * `GTKDOC_ADMIN`: allows the addition and removal of API documentation books

As mentioned above the admin_interface provides an interface for adding and removing books. Books are keyed on a name given to them at the time they are added, as well as an absolute path on the local filesystem of where the book actually is. This way, you can update the documentation (with rsync for example) and not have to touch a thing in Trac.

See also: [http://gary-kramlich.livejournal.com/10776.html original announcement].

== Bugs/Feature Requests

Existing bugs and feature requests for GtkDocPlugin are 
[report:9?COMPONENT=GtkDocPlugin here].

If you have any issues, create a 
[/newticket?component=GtkDocPlugin new ticket].

[[TicketQuery(component=GtkDocPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:gtkdocplugin here].

== Source

You can check out GtkDocPlugin from [/svn/gtkdocplugin here] using Subversion, or [source:gtkdocplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Recent Changes

[[ChangeLog(gtkdocplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:lsaavedr] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' Gary Kramlich [http://hg.guifications.org/extras/file/2bc8f2aedef7/trac/gtkdoc/tracgtkdoc tracgtkdoc]