Add REST API Documentation

[tsov]

We need a tool to generate HTML documentation of our API, before we start adding a lot of controllers

[alankehoe]

Isn't rdoc like javadocs?

Alan Kehoe

On 4 Jul 2013, at 15:17, Max Hoffmann notifications@github.com wrote:

We need a tool to generate HTML documentation of our API, before we start adding a lot of controllers

— Reply to this email directly or view it on GitHub.

[tsov]

Look at something like this: https://github.com/Pajk/apipie-rails so it generates HTML documentation for our public rest api, not documentation for classes and methods.

[tsov]

We might be using rdoc once we have more custom libraries.

[alankehoe]

Ye I know what you mean that looks like a nice tool...

Right I am off to Africa now I will be back in two weeks so best if look with finishing off the API looking forward to seeing the finished product.

Alan Kehoe

On 4 Jul 2013, at 15:40, Max Hoffmann notifications@github.com wrote:

Look at something like this: https://github.com/Pajk/apipie-rails so it generates HTML documentation for our public rest api, not documentation for classes and methods.

— Reply to this email directly or view it on GitHub.

[tsov]

This should do for this issue: https://github.com/brogrammers/eventhub-api/pull/45

[tsov]

This is done