hanna-nouveau 0.2.1 → 0.2.2

Sign up to get free protection for your applications and to get access to all the features.
data/Gemfile CHANGED
@@ -9,4 +9,5 @@ group :development do
9
9
  gem "bundler", "~> 1.0.0"
10
10
  gem "jeweler", "~> 1.5.1"
11
11
  gem "rcov", ">= 0"
12
+ gem 'rdoc', "~> 3.1"
12
13
  end
data/Gemfile.lock CHANGED
@@ -8,6 +8,7 @@ GEM
8
8
  rake
9
9
  rake (0.8.7)
10
10
  rcov (0.9.9)
11
+ rdoc (3.1)
11
12
 
12
13
  PLATFORMS
13
14
  ruby
@@ -16,3 +17,4 @@ DEPENDENCIES
16
17
  bundler (~> 1.0.0)
17
18
  jeweler (~> 1.5.1)
18
19
  rcov
20
+ rdoc (~> 3.1)
data/README.rdoc CHANGED
@@ -9,7 +9,7 @@ wiki}[http://github.com/mislav/hanna/wikis/home].)
9
9
 
10
10
  Hanna gem is available from http://rubygems.org:
11
11
 
12
- gem install hanna
12
+ gem install hanna-nouveau
13
13
 
14
14
  The template was created by {Mislav}[http://mislav.caboo.se/] and since then
15
15
  has seen contributions from:
@@ -18,7 +18,7 @@ has seen contributions from:
18
18
  the early start and made tons of fixes and enhancements to the template;
19
19
  2. {Hongli Lai}[http://blog.phusion.nl/] with the search filter for methods.
20
20
  3. {Erik Hollensbe}[http://github.com/erikh] a serious refactoring and up to
21
- date with RDoc 2.5.x.
21
+ date with RDoc 2.5.x and 3.x, now named 'hanna-nouveau'.
22
22
  4. {James Tucker}[http://github.com/raggi] minor cleanups for Erik.
23
23
 
24
24
  == Usage
@@ -39,16 +39,25 @@ RubyGems use Hanna for all rdoc generation:
39
39
  rdoc: -f hanna
40
40
 
41
41
  This will make RubyGems use Hanna when generating documentation for installed
42
- gems.
42
+ gems. Remember, if you wish to have all your gems be formatted in hanna:
43
+
44
+ gem rdoc --all --overwrite
45
+
46
+ The first time. To easily browse your newly created documentation, use:
47
+
48
+ gem server
43
49
 
44
50
  == Rake task
45
51
 
46
52
  For repeated generation of API docs, it's better to set up a Rake task. Simply
47
53
  add the hanna format argument to your RDoc::Task options:
48
54
 
49
- require 'hanna'
55
+ gem 'rdoc'
50
56
  require 'rdoc/task'
51
57
  RDoc::Task.new do |rdoc|
58
+ # this only works with RDoc 3.1 or greater
59
+ rdoc.generator = 'hanna'
60
+ # this is what you use pre RDoc 3.1:
52
61
  rdoc.options.push '-f', 'hanna'
53
62
  end
54
63
 
@@ -58,51 +67,15 @@ Tip: you can do this in the Rakefile of your Rails project before running
58
67
  Here is an example of a task for the {rdbi
59
68
  library}[http://github.com/rdbi/rdbi/tree/master/Rakefile]:
60
69
 
61
- require 'hanna'
70
+ gem 'rdoc'
62
71
  require 'rdoc/task'
63
72
  RDoc::Task.new do |rdoc|
64
73
  version = File.exist?('VERSION') ? File.read('VERSION') : ""
65
74
 
66
- rdoc.options.push '-f', 'hanna'
75
+ rdoc.generator = 'hanna'
67
76
  rdoc.main = 'README.rdoc'
68
77
  rdoc.rdoc_dir = 'rdoc'
69
78
  rdoc.title = "RDBI #{version} Documentation"
70
79
  rdoc.rdoc_files.include('README*')
71
80
  rdoc.rdoc_files.include('lib/**/*.rb')
72
81
  end
73
-
74
- == Generating documentation for installed gems
75
-
76
- The gem comes with a RubyGems plugin that overrides the gem default arguments
77
- to RDoc to use Hanna.
78
-
79
- To regenerate documentation for a specific gem, first configure RubyGems to
80
- use Hanna, by adding the following to your .gemrc:
81
-
82
- rdoc: -f hanna
83
-
84
- Now to regenerate documentation for an already installed gem:
85
-
86
- gem rdoc mygem --overwrite
87
-
88
- To regenerate documentation for all gems:
89
-
90
- gem rdoc --all --overwrite
91
-
92
- To easily browse your newly created documentation, use `gem server`.
93
-
94
- == You can help
95
-
96
- Don't like something? Think you can design better? (You probably can.)
97
-
98
- I think of Hanna as the first RDoc template that's actually _maintainable_.
99
- First thing I have done is converted the original HTML template to Haml and
100
- Sass, cleaning up and removing the (ridiculous amount of) duplication. Also,
101
- the template fragments are now in _separate files_.
102
-
103
- Ultimately, I'd like to lose the frameset. Currently that is far from possible
104
- because the whole RDoc HTML Generator is built for frames. Still, that is my
105
- goal.
106
-
107
- This is git. Fork it, hack away, tell me about it!
108
-
data/Rakefile CHANGED
@@ -15,10 +15,10 @@ Jeweler::Tasks.new do |gem|
15
15
  gem.name = "hanna-nouveau"
16
16
  gem.homepage = "http://github.com/erikh/hanna-nouveau"
17
17
  gem.license = "MIT"
18
- gem.summary = %Q{A rework of the Hanna generator for RDoc 2.5 and 3.0}
18
+ gem.summary = %Q{A rework of the Hanna generator for RDoc 2.5 and 3.x}
19
19
  gem.description = %Q{}
20
20
  gem.email = "erik@hollensbe.org"
21
- gem.authors = ["Erik Hollensbe"]
21
+ gem.authors = ["Erik Hollensbe", "James Tucker", "Mislav Marohnić"]
22
22
  # Include your dependencies below. Runtime dependencies are required when using your gem,
23
23
  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
24
24
  gem.add_runtime_dependency 'haml'
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.2.1
1
+ 0.2.2
@@ -5,11 +5,11 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = %q{hanna-nouveau}
8
- s.version = "0.2.1"
8
+ s.version = "0.2.2"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
- s.authors = ["Erik Hollensbe"]
12
- s.date = %q{2010-12-23}
11
+ s.authors = ["Erik Hollensbe", "James Tucker", "Mislav Marohni\304\207"]
12
+ s.date = %q{2010-12-28}
13
13
  s.description = %q{}
14
14
  s.email = %q{erik@hollensbe.org}
15
15
  s.extra_rdoc_files = [
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
42
42
  s.licenses = ["MIT"]
43
43
  s.require_paths = ["lib"]
44
44
  s.rubygems_version = %q{1.3.7}
45
- s.summary = %q{A rework of the Hanna generator for RDoc 2.5 and 3.0}
45
+ s.summary = %q{A rework of the Hanna generator for RDoc 2.5 and 3.x}
46
46
 
47
47
  if s.respond_to? :specification_version then
48
48
  current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -52,6 +52,7 @@ Gem::Specification.new do |s|
52
52
  s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
53
53
  s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
54
54
  s.add_development_dependency(%q<rcov>, [">= 0"])
55
+ s.add_development_dependency(%q<rdoc>, ["~> 3.1"])
55
56
  s.add_runtime_dependency(%q<haml>, [">= 0"])
56
57
  s.add_runtime_dependency(%q<rdoc>, [">= 0"])
57
58
  s.add_development_dependency(%q<jeweler>, [">= 0"])
@@ -60,6 +61,7 @@ Gem::Specification.new do |s|
60
61
  s.add_dependency(%q<bundler>, ["~> 1.0.0"])
61
62
  s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
62
63
  s.add_dependency(%q<rcov>, [">= 0"])
64
+ s.add_dependency(%q<rdoc>, ["~> 3.1"])
63
65
  s.add_dependency(%q<haml>, [">= 0"])
64
66
  s.add_dependency(%q<rdoc>, [">= 0"])
65
67
  s.add_dependency(%q<jeweler>, [">= 0"])
@@ -69,6 +71,7 @@ Gem::Specification.new do |s|
69
71
  s.add_dependency(%q<bundler>, ["~> 1.0.0"])
70
72
  s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
71
73
  s.add_dependency(%q<rcov>, [">= 0"])
74
+ s.add_dependency(%q<rdoc>, ["~> 3.1"])
72
75
  s.add_dependency(%q<haml>, [">= 0"])
73
76
  s.add_dependency(%q<rdoc>, [">= 0"])
74
77
  s.add_dependency(%q<jeweler>, [">= 0"])
data/lib/hanna-nouveau.rb CHANGED
@@ -40,6 +40,8 @@ class RDoc::Generator::Hanna
40
40
  METHOD_INDEX_OUT = 'fr_method_index.html'
41
41
  STYLE_OUT = File.join('css', 'style.css')
42
42
 
43
+ DESCRIPTION = 'a HAML-based HTML generator that scales'
44
+
43
45
  # EPIC CUT AND PASTE TIEM NAO -- GG
44
46
  RDoc::RDoc.add_generator( self )
45
47
 
metadata CHANGED
@@ -1,117 +1,142 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: hanna-nouveau
3
3
  version: !ruby/object:Gem::Version
4
+ hash: 19
4
5
  prerelease: false
5
6
  segments:
6
7
  - 0
7
8
  - 2
8
- - 1
9
- version: 0.2.1
9
+ - 2
10
+ version: 0.2.2
10
11
  platform: ruby
11
12
  authors:
12
13
  - Erik Hollensbe
14
+ - James Tucker
15
+ - "Mislav Marohni\xC4\x87"
13
16
  autorequire:
14
17
  bindir: bin
15
18
  cert_chain: []
16
19
 
17
- date: 2010-12-23 00:00:00 -05:00
20
+ date: 2010-12-28 00:00:00 -05:00
18
21
  default_executable:
19
22
  dependencies:
20
23
  - !ruby/object:Gem::Dependency
24
+ type: :development
25
+ prerelease: false
21
26
  name: bundler
22
- requirement: &id001 !ruby/object:Gem::Requirement
27
+ version_requirements: &id001 !ruby/object:Gem::Requirement
23
28
  none: false
24
29
  requirements:
25
30
  - - ~>
26
31
  - !ruby/object:Gem::Version
32
+ hash: 23
27
33
  segments:
28
34
  - 1
29
35
  - 0
30
36
  - 0
31
37
  version: 1.0.0
38
+ requirement: *id001
39
+ - !ruby/object:Gem::Dependency
32
40
  type: :development
33
41
  prerelease: false
34
- version_requirements: *id001
35
- - !ruby/object:Gem::Dependency
36
42
  name: jeweler
37
- requirement: &id002 !ruby/object:Gem::Requirement
43
+ version_requirements: &id002 !ruby/object:Gem::Requirement
38
44
  none: false
39
45
  requirements:
40
46
  - - ~>
41
47
  - !ruby/object:Gem::Version
48
+ hash: 1
42
49
  segments:
43
50
  - 1
44
51
  - 5
45
52
  - 1
46
53
  version: 1.5.1
54
+ requirement: *id002
55
+ - !ruby/object:Gem::Dependency
47
56
  type: :development
48
57
  prerelease: false
49
- version_requirements: *id002
50
- - !ruby/object:Gem::Dependency
51
58
  name: rcov
52
- requirement: &id003 !ruby/object:Gem::Requirement
59
+ version_requirements: &id003 !ruby/object:Gem::Requirement
53
60
  none: false
54
61
  requirements:
55
62
  - - ">="
56
63
  - !ruby/object:Gem::Version
64
+ hash: 3
57
65
  segments:
58
66
  - 0
59
67
  version: "0"
68
+ requirement: *id003
69
+ - !ruby/object:Gem::Dependency
60
70
  type: :development
61
71
  prerelease: false
62
- version_requirements: *id003
72
+ name: rdoc
73
+ version_requirements: &id004 !ruby/object:Gem::Requirement
74
+ none: false
75
+ requirements:
76
+ - - ~>
77
+ - !ruby/object:Gem::Version
78
+ hash: 5
79
+ segments:
80
+ - 3
81
+ - 1
82
+ version: "3.1"
83
+ requirement: *id004
63
84
  - !ruby/object:Gem::Dependency
85
+ type: :runtime
86
+ prerelease: false
64
87
  name: haml
65
- requirement: &id004 !ruby/object:Gem::Requirement
88
+ version_requirements: &id005 !ruby/object:Gem::Requirement
66
89
  none: false
67
90
  requirements:
68
91
  - - ">="
69
92
  - !ruby/object:Gem::Version
93
+ hash: 3
70
94
  segments:
71
95
  - 0
72
96
  version: "0"
97
+ requirement: *id005
98
+ - !ruby/object:Gem::Dependency
73
99
  type: :runtime
74
100
  prerelease: false
75
- version_requirements: *id004
76
- - !ruby/object:Gem::Dependency
77
101
  name: rdoc
78
- requirement: &id005 !ruby/object:Gem::Requirement
102
+ version_requirements: &id006 !ruby/object:Gem::Requirement
79
103
  none: false
80
104
  requirements:
81
105
  - - ">="
82
106
  - !ruby/object:Gem::Version
107
+ hash: 3
83
108
  segments:
84
109
  - 0
85
110
  version: "0"
86
- type: :runtime
87
- prerelease: false
88
- version_requirements: *id005
111
+ requirement: *id006
89
112
  - !ruby/object:Gem::Dependency
113
+ type: :development
114
+ prerelease: false
90
115
  name: jeweler
91
- requirement: &id006 !ruby/object:Gem::Requirement
116
+ version_requirements: &id007 !ruby/object:Gem::Requirement
92
117
  none: false
93
118
  requirements:
94
119
  - - ">="
95
120
  - !ruby/object:Gem::Version
121
+ hash: 3
96
122
  segments:
97
123
  - 0
98
124
  version: "0"
125
+ requirement: *id007
126
+ - !ruby/object:Gem::Dependency
99
127
  type: :development
100
128
  prerelease: false
101
- version_requirements: *id006
102
- - !ruby/object:Gem::Dependency
103
129
  name: rake
104
- requirement: &id007 !ruby/object:Gem::Requirement
130
+ version_requirements: &id008 !ruby/object:Gem::Requirement
105
131
  none: false
106
132
  requirements:
107
133
  - - ">="
108
134
  - !ruby/object:Gem::Version
135
+ hash: 3
109
136
  segments:
110
137
  - 0
111
138
  version: "0"
112
- type: :development
113
- prerelease: false
114
- version_requirements: *id007
139
+ requirement: *id008
115
140
  description: ""
116
141
  email: erik@hollensbe.org
117
142
  executables: []
@@ -156,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
156
181
  requirements:
157
182
  - - ">="
158
183
  - !ruby/object:Gem::Version
159
- hash: 1346323380456454675
184
+ hash: 3
160
185
  segments:
161
186
  - 0
162
187
  version: "0"
@@ -165,6 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
165
190
  requirements:
166
191
  - - ">="
167
192
  - !ruby/object:Gem::Version
193
+ hash: 3
168
194
  segments:
169
195
  - 0
170
196
  version: "0"
@@ -174,6 +200,6 @@ rubyforge_project:
174
200
  rubygems_version: 1.3.7
175
201
  signing_key:
176
202
  specification_version: 3
177
- summary: A rework of the Hanna generator for RDoc 2.5 and 3.0
203
+ summary: A rework of the Hanna generator for RDoc 2.5 and 3.x
178
204
  test_files: []
179
205