wiki:DoxygenPlugin

Version 12 (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.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.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

The path to the documentation points to the directory, in which the main.html resides.

[doxygen]
path = <path_to_the_doxygen_documentation>

Configuring Doxygen

The only configuration tags that are required in to make this plugin work are 'GENERATE_HTML' and 'GENERATE_TREEVIEW'. Since this plugin just embeds the html pages generated by 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'.

Request for Comment

Currently, I'm not able to get this plugin running (Trac 0.9.3), the tab is displayed, but without any content. I tried it on two very different machines, which makes wrong paths very unlikly. Anyone else expierence such problems? Any development to be expected in the near future?

Author/Contributors

Author: jparks
Contributors:

TagIt(plugin,jparks,alpha,0.9)?