Browse files

update gemspec for updating the new style of "table of contents"

  • Loading branch information...
1 parent 6ce9f8d commit 28d7ff2c2eda32a126d6ef2ed4cec24e942038a3 Sebastian Pape committed Jun 13, 2012
Showing with 3 additions and 3 deletions.
  1. +1 −1 VERSION
  2. BIN templates/default/.DS_Store
  3. +2 −2 yard-rest.gemspec
@@ -1 +1 @@
BIN templates/default/.DS_Store
Binary file not shown.
4 yard-rest.gemspec
@@ -5,11 +5,11 @@ do |s| = "yard-rest"
- s.version = "1.1.1"
+ s.version = "1.1.2"
s.required_rubygems_version =">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Sebastian Pape"]
- = "2012-06-08"
+ = "2012-06-13"
s.description = "A customized plugin for Yardoc that produces API documentation for Restful web services" = ""
s.extra_rdoc_files = [

8 comments on commit 28d7ff2


Current version (installed gem via Bundler using :git => "url"), doesn't use templates associated with this plugin.

I think the gem is working, due to the lack of errors / warnings when I use --plugin yard-rest.

  • without that option, yard doesn't know what to do with all the tags.

I have @resource /categories in my class comment
and @resource /categories/[id] in my index action for that controller.

outputted documentation (as viewed via the yardoc server) does not appear (markup doesn't even show an attempt at using the templates that come with this gem.

Maybe I configured something wrong?

Would love to get this working =D


You should try to use just "--plugin rest" (instead of "--plugin yard-rest").

Normaly we use the --output-dir option to publish the documentation to the rails public folder. Then on production anyone can access the documentation while navigating to "/api" on our server:

bundle exec yardoc --plugin rest --title 'Our App's API' --readme "./doc/README_FOR_API" --output-dir ./public/api


ok, yeah, I see that it works with the --output-dir. Excellent.
And thats' a good idea. allowing the API to be visible to everyone through rails, vs having to run a separate server on the production server.

And, I found out that I wasn't running 'yard server' with bundle, so it wasn't using the correct binaries - your gem plugin works well with the yard server =D

thanks! =D


Do you have a place to post issues? cause I found that this syntax: See {Category} for the object_types (for linking to other objects - this one is a model) I added the @resource tag to the class (and the constants I want visible), but it does not appear in the rendered files.


are there plans to include a tag for status codes with the example responses?


I noticed: when outputting to a directory, the file paths aren't relative to that folder, but relative to the domain.

so, ends up being



Using the latest version (Bundler pointing on this git repo), I have an error message when executing yardoc and nothing more than the standard Yard documentation. I paste the error below.
I tried with other versions of Yard and also with ruby 1.8.7 but I always have the same error.

bundle exec yardoc --plugin rest examples_controller.rb # File from the example/app/controllers directory
[error]: Exception occurred while generating 'top-level-namespace.html'
[error]: NoMethodError: undefined method delete_if' for nil:NilClass
[error]: Stack trace:
/home/cmorandi/.rvm/gems/ruby-1.9.3-p125/gems/yard-rest-1.1.2/lib/yard-rest/rest_filters.rb:4:in index_objects'
/home/cmorandi/.rvm/gems/ruby-1.9.3-p125/gems/yard- render_section'
block (2 levels) in run'
/home/cmorandi/.rvm/gems/ruby-1.9.3-p125/gems/yard- `each'

I probably missed something but I really have no idea of what it is.


try bundle exec yardoc --plugin rest ./app/controllers/*.rb

you should execute this within your app's root directory

Please sign in to comment.