yard-api 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. checksums.yaml +7 -0
  2. data/.rspec +3 -0
  3. data/LICENSE +674 -0
  4. data/README.md +27 -0
  5. data/lib/yard-api/markup/redcarpet.rb +42 -0
  6. data/lib/yard-api/options.rb +13 -0
  7. data/lib/yard-api/railtie.rb +11 -0
  8. data/lib/yard-api/tags.rb +16 -0
  9. data/lib/yard-api/templates/helpers/base_helper.rb +108 -0
  10. data/lib/yard-api/templates/helpers/html_helper.rb +87 -0
  11. data/lib/yard-api/templates/helpers/route_helper.rb +19 -0
  12. data/lib/yard-api/verifier.rb +34 -0
  13. data/lib/yard-api/version.rb +5 -0
  14. data/lib/yard-api/yardoc_task.rb +78 -0
  15. data/lib/yard-api.rb +48 -0
  16. data/spec/spec_helper.rb +44 -0
  17. data/tasks/yard_api.rake +13 -0
  18. data/templates/api/appendix/html/setup.rb +19 -0
  19. data/templates/api/docstring/html/setup.rb +3 -0
  20. data/templates/api/docstring/html/text.erb +6 -0
  21. data/templates/api/fulldoc/html/setup.rb +78 -0
  22. data/templates/api/layout/html/footer.erb +11 -0
  23. data/templates/api/layout/html/headers.erb +19 -0
  24. data/templates/api/layout/html/layout.erb +17 -0
  25. data/templates/api/layout/html/scripts.erb +35 -0
  26. data/templates/api/layout/html/setup.rb +63 -0
  27. data/templates/api/layout/html/sidebar.erb +29 -0
  28. data/templates/api/method_details/html/header.erb +12 -0
  29. data/templates/api/method_details/html/method_signature.erb +19 -0
  30. data/templates/api/method_details/html/setup.rb +35 -0
  31. data/templates/api/tags/html/_example_code_block.erb +8 -0
  32. data/templates/api/tags/html/argument.erb +32 -0
  33. data/templates/api/tags/html/emits.erb +7 -0
  34. data/templates/api/tags/html/example_request.erb +13 -0
  35. data/templates/api/tags/html/example_response.erb +14 -0
  36. data/templates/api/tags/html/generic_tag.erb +20 -0
  37. data/templates/api/tags/html/index.erb +3 -0
  38. data/templates/api/tags/html/no_content.erb +3 -0
  39. data/templates/api/tags/html/note.erb +6 -0
  40. data/templates/api/tags/html/returns.erb +10 -0
  41. data/templates/api/tags/html/see.erb +8 -0
  42. data/templates/api/tags/html/throws.erb +49 -0
  43. data/templates/api/tags/html/warning.erb +6 -0
  44. data/templates/api/tags/setup.rb +83 -0
  45. data/templates/api/topic/html/header.erb +7 -0
  46. data/templates/api/topic/html/method_details_list.erb +5 -0
  47. data/templates/api/topic/html/setup.rb +58 -0
  48. data/templates/api/topic/html/topic_doc.erb +27 -0
  49. data/yard-api.gemspec +22 -0
  50. metadata +149 -0
metadata ADDED
@@ -0,0 +1,149 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: yard-api
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Ahmad Amireh
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-09-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: yard
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '='
18
+ - !ruby/object:Gem::Version
19
+ version: 0.8.7
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '='
25
+ - !ruby/object:Gem::Version
26
+ version: 0.8.7
27
+ - !ruby/object:Gem::Dependency
28
+ name: yard-appendix
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 0.1.8
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: 0.1.8
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: gem-release
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: |2
70
+ TBD
71
+ email: ahmad@instructure.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".rspec"
77
+ - LICENSE
78
+ - README.md
79
+ - lib/yard-api.rb
80
+ - lib/yard-api/markup/redcarpet.rb
81
+ - lib/yard-api/options.rb
82
+ - lib/yard-api/railtie.rb
83
+ - lib/yard-api/tags.rb
84
+ - lib/yard-api/templates/helpers/base_helper.rb
85
+ - lib/yard-api/templates/helpers/html_helper.rb
86
+ - lib/yard-api/templates/helpers/route_helper.rb
87
+ - lib/yard-api/verifier.rb
88
+ - lib/yard-api/version.rb
89
+ - lib/yard-api/yardoc_task.rb
90
+ - spec/spec_helper.rb
91
+ - tasks/yard_api.rake
92
+ - templates/api/appendix/html/setup.rb
93
+ - templates/api/docstring/html/setup.rb
94
+ - templates/api/docstring/html/text.erb
95
+ - templates/api/fulldoc/html/setup.rb
96
+ - templates/api/layout/html/footer.erb
97
+ - templates/api/layout/html/headers.erb
98
+ - templates/api/layout/html/layout.erb
99
+ - templates/api/layout/html/scripts.erb
100
+ - templates/api/layout/html/setup.rb
101
+ - templates/api/layout/html/sidebar.erb
102
+ - templates/api/method_details/html/header.erb
103
+ - templates/api/method_details/html/method_signature.erb
104
+ - templates/api/method_details/html/setup.rb
105
+ - templates/api/tags/html/_example_code_block.erb
106
+ - templates/api/tags/html/argument.erb
107
+ - templates/api/tags/html/emits.erb
108
+ - templates/api/tags/html/example_request.erb
109
+ - templates/api/tags/html/example_response.erb
110
+ - templates/api/tags/html/generic_tag.erb
111
+ - templates/api/tags/html/index.erb
112
+ - templates/api/tags/html/no_content.erb
113
+ - templates/api/tags/html/note.erb
114
+ - templates/api/tags/html/returns.erb
115
+ - templates/api/tags/html/see.erb
116
+ - templates/api/tags/html/throws.erb
117
+ - templates/api/tags/html/warning.erb
118
+ - templates/api/tags/setup.rb
119
+ - templates/api/topic/html/header.erb
120
+ - templates/api/topic/html/method_details_list.erb
121
+ - templates/api/topic/html/setup.rb
122
+ - templates/api/topic/html/topic_doc.erb
123
+ - yard-api.gemspec
124
+ homepage: https://github.com/amireh/yard-api
125
+ licenses:
126
+ - AGPL3
127
+ metadata: {}
128
+ post_install_message:
129
+ rdoc_options: []
130
+ require_paths:
131
+ - lib
132
+ required_ruby_version: !ruby/object:Gem::Requirement
133
+ requirements:
134
+ - - ">="
135
+ - !ruby/object:Gem::Version
136
+ version: '0'
137
+ required_rubygems_version: !ruby/object:Gem::Requirement
138
+ requirements:
139
+ - - ">="
140
+ - !ruby/object:Gem::Version
141
+ version: '0'
142
+ requirements: []
143
+ rubyforge_project:
144
+ rubygems_version: 2.2.0
145
+ signing_key:
146
+ specification_version: 4
147
+ summary: A YARD plugin for documenting APIs in Rails projects.
148
+ test_files: []
149
+ has_rdoc: yard