Matt Silverman created a pretty comprehensive lists of what is available out there now for gen'ing docs from code.
http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html
Question
im searching for a Documentation Framework that supports the following features:
I want to use it to document an RESTfull API i'm working on
I know about YARDoc, but would be nice to gather some alternatives
Solution
Matt Silverman created a pretty comprehensive lists of what is available out there now for gen'ing docs from code.
http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html
OTHER TIPS
Apart from YARD, you can generate RDOC project documentation using the following rake task:
rake doc:app
After this, your docs will be located in the doc/app
folder and can be viewed by opening the index.html
file in your browser. It will include the (currently probably generic) doc/README_FOR_APP
file.
Hope this helps :)