In order to serve the documentation I needed to write a Redmine plugin. Next up we need to give Redmine the ability to view/serve it. Remember that this goes into local-code/hooks/common/hooks.d/, and make sure it's executable. git from the end of the name PROJECT = $ ) " ![]() # Get project name from directory name PROJECT = $( basename " $PWD " ) # Remove. So first things first, we need a hook to generate this output before we can use it in Redmine. It is also quite flexible in it's output including support for HTML and PDF (via LaTeX), as well as compiled help files for Eclipse and Xcode. Thankfully Doxygen works well with all of them and more. We use several different languages across our projects (most extensively Objective-C, Java, and PHP), so we needed something that is comfortable with all of them. From here our developers have access to relevant projects with the ability to directly view the repository for that project, so why not add a "Documentation Tab" too? Choosing a generator.Īfter evaluating a couple of doc generators we settled on the tried and true classic, Doxygen. ![]() Images//redmine-documentation.png Background.ĭocumentation is often as important as code itself, especially when working in a team or introducing new programmers.īut keeping generated documentation up to date is a pain, and it really shouldn't be.Īt (REDACTED) we use Redmine as our project/task tracker. ← all posts Live project documentation in Redmine Ĭontinuing this series of posts on Gitolite hooks, this time I will be adding live project documentation to Redmine, using Doxygen.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |