yard-rest 1.0.2 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. data/README.markdown +6 -0
  2. data/Rakefile +1 -1
  3. data/VERSION +1 -1
  4. metadata +25 -25
  5. /data/templates/{rest → default}/class/html/header.erb +0 -0
  6. /data/templates/{rest → default}/class/html/method_details_list.erb +0 -0
  7. /data/templates/{rest → default}/class/html/setup.rb +0 -0
  8. /data/templates/{rest → default}/docstring/html/setup.rb +0 -0
  9. /data/templates/{rest → default}/docstring/html/text.erb +0 -0
  10. /data/templates/{rest → default}/fulldoc/html/full_list_resource.erb +0 -0
  11. /data/templates/{rest → default}/fulldoc/html/full_list_topic.erb +0 -0
  12. /data/templates/{rest → default}/fulldoc/html/js/rest_plugin.js +0 -0
  13. /data/templates/{rest → default}/fulldoc/html/setup.rb +0 -0
  14. /data/templates/{rest → default}/layout/html/footer.erb +0 -0
  15. /data/templates/{rest → default}/layout/html/index.erb +0 -0
  16. /data/templates/{rest → default}/layout/html/layout.erb +0 -0
  17. /data/templates/{rest → default}/layout/html/search.erb +0 -0
  18. /data/templates/{rest → default}/layout/html/setup.rb +0 -0
  19. /data/templates/{rest → default}/method_details/html/header.erb +0 -0
  20. /data/templates/{rest → default}/method_details/html/method_url.erb +0 -0
  21. /data/templates/{rest → default}/method_details/html/setup.rb +0 -0
  22. /data/templates/{rest → default}/tags/html/example_request.erb +0 -0
  23. /data/templates/{rest → default}/tags/html/example_response.erb +0 -0
  24. /data/templates/{rest → default}/tags/html/generic_tag.erb +0 -0
  25. /data/templates/{rest → default}/tags/html/index.erb +0 -0
  26. /data/templates/{rest → default}/tags/html/key_for.erb +0 -0
  27. /data/templates/{rest → default}/tags/html/value_for.erb +0 -0
  28. /data/templates/{rest → default}/tags/setup.rb +0 -0
data/README.markdown CHANGED
@@ -21,6 +21,12 @@ When using yardoc you ask it to use the "rest" plugin (the --plugin option). For
21
21
 
22
22
  yardoc --plugin rest --title "Our App's API" --readme "./doc/README_FOR_API"
23
23
 
24
+ ## Publish API
25
+
26
+ When you want to make the API-documentation available for public use the following command:
27
+
28
+ bundle exec yardoc --plugin rest --title 'Our App's API' --output-dir ./public/api
29
+
24
30
  ## Gemfile functionality
25
31
 
26
32
  You may also include yard-rest in your gemfile using:
data/Rakefile CHANGED
@@ -11,7 +11,7 @@ begin
11
11
  gem.homepage = "https://github.com/spape/yard-rest-plugin"
12
12
  gem.authors = ['R. Kevin Nelson', 'Aisha Fenton', 'Sebastian Pape']
13
13
  gem.add_dependency("yard", '~>0.7.4')
14
- gem.files = Dir.glob("{lib,example,templates/rest}/**/*").concat(["Rakefile"])
14
+ gem.files = Dir.glob("{lib,example,templates}/**/*").concat(["Rakefile"])
15
15
  gem.extra_rdoc_files = ['VERSION', 'README.markdown']
16
16
  end
17
17
  Jeweler::GemcutterTasks.new
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.2
1
+ 1.0.3
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard-rest
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.2
4
+ version: 1.0.3
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -44,30 +44,30 @@ files:
44
44
  - lib/yard-rest.rb
45
45
  - lib/yard-rest/rest_filters.rb
46
46
  - lib/yard-rest/tags.rb
47
- - templates/rest/class/html/header.erb
48
- - templates/rest/class/html/method_details_list.erb
49
- - templates/rest/class/html/setup.rb
50
- - templates/rest/docstring/html/setup.rb
51
- - templates/rest/docstring/html/text.erb
52
- - templates/rest/fulldoc/html/full_list_resource.erb
53
- - templates/rest/fulldoc/html/full_list_topic.erb
54
- - templates/rest/fulldoc/html/js/rest_plugin.js
55
- - templates/rest/fulldoc/html/setup.rb
56
- - templates/rest/layout/html/footer.erb
57
- - templates/rest/layout/html/index.erb
58
- - templates/rest/layout/html/layout.erb
59
- - templates/rest/layout/html/search.erb
60
- - templates/rest/layout/html/setup.rb
61
- - templates/rest/method_details/html/header.erb
62
- - templates/rest/method_details/html/method_url.erb
63
- - templates/rest/method_details/html/setup.rb
64
- - templates/rest/tags/html/example_request.erb
65
- - templates/rest/tags/html/example_response.erb
66
- - templates/rest/tags/html/generic_tag.erb
67
- - templates/rest/tags/html/index.erb
68
- - templates/rest/tags/html/key_for.erb
69
- - templates/rest/tags/html/value_for.erb
70
- - templates/rest/tags/setup.rb
47
+ - templates/default/class/html/header.erb
48
+ - templates/default/class/html/method_details_list.erb
49
+ - templates/default/class/html/setup.rb
50
+ - templates/default/docstring/html/setup.rb
51
+ - templates/default/docstring/html/text.erb
52
+ - templates/default/fulldoc/html/full_list_resource.erb
53
+ - templates/default/fulldoc/html/full_list_topic.erb
54
+ - templates/default/fulldoc/html/js/rest_plugin.js
55
+ - templates/default/fulldoc/html/setup.rb
56
+ - templates/default/layout/html/footer.erb
57
+ - templates/default/layout/html/index.erb
58
+ - templates/default/layout/html/layout.erb
59
+ - templates/default/layout/html/search.erb
60
+ - templates/default/layout/html/setup.rb
61
+ - templates/default/method_details/html/header.erb
62
+ - templates/default/method_details/html/method_url.erb
63
+ - templates/default/method_details/html/setup.rb
64
+ - templates/default/tags/html/example_request.erb
65
+ - templates/default/tags/html/example_response.erb
66
+ - templates/default/tags/html/generic_tag.erb
67
+ - templates/default/tags/html/index.erb
68
+ - templates/default/tags/html/key_for.erb
69
+ - templates/default/tags/html/value_for.erb
70
+ - templates/default/tags/setup.rb
71
71
  - README.markdown
72
72
  - VERSION
73
73
  homepage: https://github.com/spape/yard-rest-plugin
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes