Re: api documentation generation for sinatra app

[Konstantin Haase]

We use https://github.com/rkh/yard-sinatra with the latest Sinatra on https://api.travis-ci.org/docs, use it like this: https://github.com/travis-ci/travis-api/blob/master/lib/travis/api/app/endpoint/endpoints.rb#L12-L15

Cheers,

Konstantin

On Jan 29, 2013, at 2:13 PM, Jilles van Gurp <jilles...@gmail.com> wrote:

I'm interested in generating documentation for my sinatra routes using e.g. https://github.com/ddollar/apidoc. However, this particular project seems to have had no commits since three years and I haven't been able to get it working with the latest sinatra so far. 

Is anyone using this with the latest sinatra. If so, could you provide some pointers on how to get it working. If not, are there any other tools out there that I could try or should look at?

Jilles

--
You received this message because you are subscribed to the Google Groups "sinatrarb" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sinatrarb+...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[Jilles van Gurp]

I tried that one as well. Unfortunately it doesn't play nice with jruby, which we use.

Jilles

[Jilles van Gurp]

To answer my own question, I finally managed to get something to work using this project: https://github.com/softprops/sinatra-doc

I kind of like the approach taken there and it works nicely out of the box. I'm planning to customize it a bit further. Basically it integrates a mini documentation DSL with the sinatra DSL.

Jilles

[Jilles van Gurp]

I actually spend a bit of time on this and came up with my own little DSL now: https://github.com/jillesvangurp/sinatra-docdsl.git

Jilles