Version 28 (modified by 18 years ago) (diff) | ,
---|
Doxygen Plugin for Trac
Description
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
Download the zipped source from [download:doxygenplugin 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 [download:doxygenplugin 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 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; } </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
Poll(Are you using this plugin?; Yes, it's usefull.; No, it's useless.; No, I don't need it.)?
Change Log
- 18471 by rjollos on 2022-04-06 23:39:11
-
DoxygenPlugin 0.7.5dev: Make compatible with Python 3
Patch by anonymous.
Refs #14123.
- 17631 by rjollos on 2019-12-18 19:03:49
-
DoxygenPlugin 0.7.5dev: Make compatible with Trac 1.0+
Fixes #13710.
- 16397 by rjollos on 2017-03-25 09:37:00
-
Remove obsolete "0.9" code
- 16367 by rjollos on 2017-03-22 21:24:48
-
0.7.5: Conform to PEP8
- 15902 by rjollos on 2016-09-28 11:19:17
-
0.7.4: Fix duplicate
id
attribute values
Patch by ntmlod.
Fixes #12872.
(more)
Author/Contributors
Attachments (1)
-
doxygen.png (3.8 KB) - added by 7 years ago.
Doxygen logo
Download all attachments as: .zip