YARD - Local Redmine Documentation Download

Added by Eric Davis on April 10, 2010 in Home Code

YARD Logo

Redmine has a large codebase and sometimes it's hard to find the class or method that you need for your custom development. Since I recently added support to Redmine for YARD (a powerful Ruby documentation tool) I figured that I'd post the generated documentation here.

YARD generates HTML documentation from Redmine's code comments, so it's fully automatic. I like YARD over RDoc because it has a better design and has a JavaScript search builtin.

To install, just extract one of these zip files and open the index.html in a web browser. Instant local documentation!

If you want to regenerate the documentation from your Redmine, just install the YARD gem (gem install yard) and run rake yard while in the Redmine root directory.

If you want to improve the documentation or code comments, feel free to submit a patch to Redmine and we will integrate it into the core.

Want to become more productive with Redmine?

Do you feel like you are fighting Redmine somedays? You know, that feeling where Redmine just can't seem to do what you want it to do?

I have a book that might help. Visit Redmine Tips and let's see if we can take your Redmine knowledge to the next level.

gravatar
Eric Davis

This blog is a place to learn about the Redmine Project Management application and it's community.

I am the founder of Little Stream Software, where I help project teams communicate easier by customizing Redmine. If your team could use a customized Redmine to suit your needs, please contact me.