Version 28 (modified by cboos, 10 years ago) (diff)

Improve introduction to the plugin

Doxygen Plugin for Trac


Integrates doxygen documentation into Trac.

The aim is to embed one or multiple doxygen-generated documentation(s) within Trac, in order to have consistent look and feel, and easy referencing to doxygen pages using the usual TracLinks and the doxygen: prefix.

The doxygen plugin provides a new main navigation tab (named Doxygen by default), which will present an index page. If you have to present only one documentation project, that index page can directly be a Doxygen-generated page, like the index.html, main.html (default) or hierarchy.html. An alternative is to pick a Wiki page to use as the index, and this is indeed the best option if you have multiple documentation projects to serve. That way you can build your own meta index the way you want, using doxygen:... links within that page.

Configuring the Doxygen plugin should be easy if you have only one Doxygen generated documentation to wrap, and a bit more involved if you have many --but the goal is to have a great deal of flexibility, in the latter case.

Bugs/Feature Requests

Existing bugs and feature requests for DoxygenPlugin are here.

If you have any issues, create a new ticket.


Download the zipped source from [download:doxygenplugin here].


You can check out the source for DoxygenPlugin from Subversion at



Download the source code for the DoxygenPlugin from [download:doxygenplugin here] or checkout the source from the trac hacks subversion repository at:

Change to the doxygenplugin/0.9 directory and run:

python 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

Set path where you have your doxygen documentations and specify what documentation or wiki page should be displayed as a index. Setting wiki_index variable has higher priority. You can create your own content using [doxygen:<page_name>] macro on specified wiki page and so provide easy multiple documentation support.

path = <path_to_the_doxygen_documentation>
index = <name_of_mainpage_file>
wiki_index = <name_of_wiki_page>

Doxygen generated documentation cointains html, png and sometime other files. To tell plugin which file extentions can be handled put to ![doxygen] section in trac.ini this:

ext = htm html png # Default values

If you want to change main navigation menu button label put this to ![doxygen] section in trac.ini:

title = Documentation

If you install the plugin globally, you'll also need to enable it in trac.ini as follows:

doxygentrac.* = enabled

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 need to define a custom header and footer even if it will be containing only blank line.

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. You can put there you own CSS style as in following example:

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

and my TracFooter.html contains a blank line.

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

Wiki Macros

Using provided wiki macro you can make a link to doxygen documentation page wherever you want. Specified links are related to setted up doxygen path:

[doxygen:main.html Documentation] # Simple documentation in doxygen path.
[doxygen:FirstProject/main.html First]   # Multiple documentation in separate
[doxygen:SecondProject/main.html Second] # directories in doxygen path.


Are you using this plugin?
  • Yes, it's usefull.
  • No, it's useless.
  • No, I don't need it.

  • You don't have permission to vote. You may need to login.

Change Log

15902 by rjollos on 2016-09-28 13:19:17
0.7.4: Fix duplicate id attribute values

Patch by ntmlod.

Fixes #12872.

15667 by Committo-Ergo-Sum on 2016-07-20 14:44:08
Better log messages.
15662 by Committo-Ergo-Sum on 2016-07-16 21:36:37
DoxygenPlugin: an old missing import like this one.
15430 by Committo-Ergo-Sum on 2016-03-13 22:24:10
DoxygenPlugin: as r15427: conforms to PEP8 for logger. And some more documentation.
15427 by rjollos on 2016-03-13 06:13:15
0.7.2: Pass arguments to logger rather than interpolating string

This change conforms to PEP8.

Refs #1882.



Author: jparks
Contributors: Blackhex cboos