wiki:DoxygenPlugin

Version 4 (modified by anonymous, 9 years ago) (diff)

--

Doxygen Plugin for Trac

Description

Integrates doxygen documentation into Trac.

Bugs/Feature Requests

Existing bugs and feature requests for DoxygenPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out the source for DoxygenPlugin from Subversion at http://trac-hacks.swapoff.org/svn/doxygenplugin.

Example

Installation

Download the source code for the DoxygenPlugin from here or checkout the source from the trac hacks subversion repository at: http://trac-hacks.swapoff.org/svn/doxygenplugin.

Change to the doxygenplugin/0.9 directory and run:

python setup.py bdist_egg

This will generate a python egg in the dist directory. Copy the egg file into the trac/plugins directory and follow the Configuration steps outlined below.

Configuring Trac

[doxygen]
path = <path_to_the_doxygen_documentation>

Configuring Apache

DoxygenPlugin requires mod_include to be enabled. There is a known bug with mod_include and Trac. You will need to add the following to your VirtualHost

ErrorDocument 401 default

Configuring Doxygen

The only configuration tag that is required in to make this plugin work is 'GENERATE_HTML'. Since this plugin just embeds the html pages generated be doxygen you will probably want to define a custom header and footer.

HTML_HEADER            = TracHeader.html
HTML_FOOTER            = TracFooter.html

These files must contain something, a blank line is sufficient, or doxygen will put in the defaults. My TracHeader.html contains the following:

<style type="text/css">
        h1 { text-align: center; }
</style>

and my TracFooter.html contains a blank line.

To enable the search option the SEARCHENGINE tag must be set to 'YES'.

Author/Contributors

Author: jparks
Contributors:

TagIt(plugin,jparks,alpha,0.9)?