wiki:DoxygenPlugin

Version 25 (modified by Blackhex, 8 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

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.

[doxygen]
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:

[doxygen]
ext = htm html png # Default values

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

[doxygen]
title = Documentation

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

[components]
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 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'.

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.

Feedback

Are you using this plugin?
  • Yes, it's usefull. (sgrayban, cboos, okaori, wadeb, s0undt3ch, ttressieres, imme, dh1jc, talameelombu, Tharban, athomas, jtuchscherer, xvirus, osimons, Sincklation, manni, izzy, ericalens, KevinGabbert, mwehr, renzo, marcvs, eskil, rjollos, koolhand, edo, colski, dfleming, lucasrangit, miezuit, lhr870630, hasienda, arnisandy, lucid, AdrianFritz, akliewer99)
  • No, it's useless.
  • No, I don't need it. (dfaerch, harmy, prz)

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

Change Log

[12233] by rjollos on 2012-10-22 01:05:28
Fixes #7247: Changed the default value for html_output to be an empty string.
[11777] by rjollos on 2012-07-25 09:46:39
Added setup.cfg.
[10461] by rjollos on 2011-07-12 08:10:24
Show plugin's svn revision on webadmin plugin panel.
[6328] by cboos on 2009-08-06 16:59:46
DoxygenPlugin: add Windows compatibility.

Closes #5588.

[6327] by cboos on 2009-08-06 16:53:17
DoxygenPlugin: remove stray <?cs include ?> from Genshi template

Author/Contributors

Author: jparks
Contributors: Blackhex