Rails RESTfull API Documentation

Question

im searching for a Documentation Framework that supports the following features:

Generated from Code Comments
Searchable
Styling customizable
NTH: Linked references (If i reference a class somewhere class name should be linked to class documentation)

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

score 1 · Accepted Answer · answered Apr 09 '13 at 21:06

1

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

answered Apr 09 '13 at 21:06

MoxieandMore

1,096
11
8

Thanks that's really quite useful :) – MaThGo Apr 10 '13 at 06:40

Jaap Haagmans · Answer 2 · 2013-04-09T15:34:37.520

0

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 :)

edited Apr 09 '13 at 15:34

answered Apr 09 '13 at 15:17

Jaap Haagmans

6,232
1
25
30

Rails RESTfull API Documentation

2 Answers2