hanna-nouveau 0.4.2 → 1.0.4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 90fc1d5075e795e811bc3563e1f10175d191695d
4
- data.tar.gz: 46ce6bee79f39f4074c6059140be2dec93e6fe27
2
+ SHA256:
3
+ metadata.gz: 0e4733e305512509fd556760a86b51b7d6d1c7ddaead28158d629da239de58c5
4
+ data.tar.gz: 137e9ddc6da0ce83e8fe78569327d6cb8767161c180e4cd9dd6ef5ddc3037592
5
5
  SHA512:
6
- metadata.gz: 999e141beaca424c55e4cb0ce1288e75d0c9e40967d2b458eca5b319bd95862b06f3c161dc9a8681b7ffebe21d65a558e559133e89b01964da2f7a3b32fed230
7
- data.tar.gz: 1fa28e301d10546c979f25bf86958e33f6d63eecff9983fbe94c43609c59a11a296bae4d1cd3f69f8aacb7e570009ba177532524acd7ab2144a26e3cdde380ce
6
+ metadata.gz: 6759cda40d0cf8da841dcd9196002e1d605549ab11bff276f7f47a94a0e0b5aa552e9e46748382299631b851549c0f56ade7ab3160a380f970bd0448fdd43dbc
7
+ data.tar.gz: 1626375c53ccf5e4a33f5589721fae1c795b41fe811889f9ef2cff6a71dcd5f9f81ae86f23daa50b220032c70bf06a3fbf74864db9f18e8cfabd3294562fa683
data/LICENSE CHANGED
@@ -1,5 +1,6 @@
1
1
  Copyright (c) 2009 Mislav Marohnić
2
2
  Copyright (c) 2010, 2011 Erik Hollensbe
3
+ Copyright (c) 2011-2020 Jeremy Evans
3
4
 
4
5
  Permission is hereby granted, free of charge, to any person obtaining a copy of
5
6
  this software and associated documentation files (the "Software"), to deal in
@@ -1,17 +1,16 @@
1
- = Hanna Nouveau — a better RDoc template, now for RDoc 4.
1
+ = Hanna-nouveau
2
2
 
3
3
  Based on the original Hanna by Mislav.
4
4
 
5
- Hanna is an RDoc generator that scales. It's implemented in Haml, making the
6
- sources clean and readable. It's built with simplicity, beauty and ease of
7
- browsing in mind. (See more in {the
8
- wiki}[http://github.com/mislav/hanna/wikis/home].)
5
+ Hanna-nouveau is an RDoc generator that scales. It's implemented in Haml,
6
+ making the sources clean and readable. It's built with simplicity, beauty
7
+ and ease of browsing in mind.
9
8
 
10
- Hanna gem is available from http://rubygems.org:
9
+ Hanna-nouveau is distributed as a ruby gem:
11
10
 
12
11
  gem install hanna-nouveau
13
12
 
14
- The template was created by {Mislav}[http://mislav.caboo.se/] and since then
13
+ The template was created by {Mislav}[http://mislav.uniqpath.com/] and since then
15
14
  has seen contributions from:
16
15
 
17
16
  1. {Tony Strauss}[http://github.com/DesigningPatterns], who participated from
@@ -20,16 +19,18 @@ has seen contributions from:
20
19
  3. {Erik Hollensbe}[http://github.com/erikh] a serious refactoring and up to
21
20
  date with RDoc 2.5.x and 3.x, now named 'hanna-nouveau'.
22
21
  4. {James Tucker}[http://github.com/raggi] minor cleanups for Erik.
22
+ 5. {Jeremy Evans}[http://github.com/jeremyevans] RDoc 4 support, maintenance
23
+ since 2014.
23
24
 
24
25
  == Usage
25
26
 
26
- rdoc -o doc -f hanna lib/*.rb
27
+ rdoc -o doc -f hanna lib
27
28
 
28
29
  An alternative is to set the `RDOCOPT` environment variable:
29
30
 
30
31
  RDOCOPT="-f hanna"
31
32
 
32
- This will make RDoc always use Hanna unless it is explicitly overridden.
33
+ This will make RDoc always use hanna-nouveau unless it is explicitly overridden.
33
34
 
34
35
  == Integrating with RubyGems
35
36
 
@@ -55,10 +56,7 @@ add the hanna format argument to your RDoc::Task options:
55
56
  gem 'rdoc'
56
57
  require 'rdoc/task'
57
58
  RDoc::Task.new do |rdoc|
58
- # this only works with RDoc 3.1 or greater
59
59
  rdoc.generator = 'hanna'
60
- # this is what you use pre RDoc 3.1:
61
- rdoc.options.push '-f', 'hanna'
62
60
  end
63
61
 
64
62
  Tip: you can do this in the Rakefile of your Rails project before running
@@ -80,16 +78,10 @@ library}[http://github.com/rdbi/rdbi/tree/master/Rakefile]:
80
78
  rdoc.rdoc_files.include('lib/**/*.rb')
81
79
  end
82
80
 
83
- == Modifications to RDoc
81
+ == Modification to RDoc
84
82
 
85
- Hanna makes some small modifications to RDoc to generate more
86
- friendly documentation. First, a real parser is used for all
87
- verbatim sections, and any verbatim section that is valid ruby
88
- code will be highlighted. This is different than the RDoc
89
- default, which is to use a simple regexp with both false
90
- positives and false negatives.
91
-
92
- Second, label lists are marked using a table instead of a
93
- description list, since it is very difficult to get visually
94
- appealing styling for description lists without cutting
95
- corners (like using fixed widths).
83
+ Hanna makes a small modification to RDoc to generate more
84
+ friendly documentation. It changes label lists to use a table
85
+ instead of a description list, since it is very difficult to
86
+ get visually appealing styling for description lists without
87
+ cutting corners (like using fixed widths).
data/Rakefile CHANGED
@@ -6,7 +6,8 @@ RDoc::Task.new do |rdoc|
6
6
  version = File.exist?('VERSION') ? File.read('VERSION') : ""
7
7
 
8
8
  rdoc.rdoc_dir = 'rdoc'
9
+ rdoc.generator = 'hanna'
9
10
  rdoc.title = "hanna-nouveau #{version}"
10
- rdoc.options = ['-f', 'hanna']
11
- rdoc.rdoc_files.add %w"README.rdoc LICENSE lib/hanna-nouveau.rb"
11
+ rdoc.options = ['--main', 'README.rdoc', '--title', 'Hanna-nouveau: RDoc generator designed with simplicity, beauty and ease of browsing in mind']
12
+ rdoc.rdoc_files.add %w"README.rdoc LICENSE lib"
12
13
  end
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.4.2
1
+ 1.0.4
@@ -42,12 +42,6 @@ class RDoc::Markup::ToHtml
42
42
  raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
43
43
  end
44
44
  end
45
-
46
- def parseable? text
47
- eval("BEGIN {return true}\n#{text}")
48
- rescue SyntaxError
49
- false
50
- end
51
45
  end
52
46
 
53
47
  class RDoc::Generator::Hanna
@@ -322,7 +316,7 @@ class RDoc::Generator::Hanna
322
316
  class_attr = classname ? ' class="%s"' % classname : ''
323
317
 
324
318
  if url
325
- %[<a target="docwin" href="#{url}"#{class_attr}>#{text}</a>]
319
+ %[<a href="#{url}"#{class_attr}>#{text}</a>]
326
320
  elsif classname
327
321
  %[<span#{class_attr}>#{text}</span>]
328
322
  else
@@ -31,4 +31,4 @@
31
31
  = yield
32
32
  #footer-push
33
33
  #footer
34
- = link_to '<strong>Hanna</strong> RDoc template', 'http://github.com/mislav/hanna/tree/master'
34
+ = link_to '<strong>Hanna Nouveau</strong> RDoc template', 'https://github.com/rdoc/hanna-nouveau'
@@ -29,7 +29,7 @@
29
29
  - if !file_page && values[:entry].type == "class"
30
30
  .parent
31
31
  Superclass:
32
- - if values[:entry].superclass.kind_of?(String)
32
+ - if values[:entry].superclass.kind_of?(String) || !values[:entry].superclass
33
33
  %strong= values[:entry].superclass
34
34
  - else
35
35
  %strong= link_to values[:entry].superclass.name, Pathname.new(class_dir) + Pathname.new(values[:entry].superclass.path).relative_path_from(Pathname.new values[:entry].path)
@@ -70,7 +70,7 @@
70
70
  - method.call_seq.split(/\r?\n/).each do |seq|
71
71
  %div=seq
72
72
  - else
73
- %span.name= method.name
73
+ %span.name>= method.name
74
74
  %span.arguments= method.params
75
75
  -#- if method[:codeurl]
76
76
  -#%a.method-signature{ :href => method[:codeurl], :onclick => "popupCode(this.href); return false", :target => "Code" }
@@ -5,7 +5,7 @@ $code_font_size: 14px
5
5
  $code_font: $code_font_size $code_font_family
6
6
 
7
7
  $light_link: #336699
8
- $link: $light_link - 40
8
+ $link: #0b3e71
9
9
  $light_text: #666666
10
10
  $dark_blue_text: #0e3062
11
11
 
@@ -189,12 +189,12 @@ div.header
189
189
  .paths, .last-update, .parent
190
190
  color: $light_text
191
191
  .last-update .datetime
192
- color: $light_text - 30
192
+ color: #484848
193
193
  .parent
194
194
  margin-top: 0.3em
195
195
  strong
196
196
  font-weight: normal
197
- color: $light_text - 30
197
+ color: #484848
198
198
 
199
199
  #content
200
200
  padding: 12px 2%
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: hanna-nouveau
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.2
4
+ version: 1.0.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jeremy Evans
@@ -11,37 +11,55 @@ authors:
11
11
  autorequire:
12
12
  bindir: bin
13
13
  cert_chain: []
14
- date: 2014-11-26 00:00:00.000000000 Z
14
+ date: 2020-06-24 00:00:00.000000000 Z
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency
17
17
  name: haml
18
18
  requirement: !ruby/object:Gem::Requirement
19
19
  requirements:
20
- - - '='
20
+ - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.0.25
22
+ version: '4'
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
26
26
  requirements:
27
- - - '='
27
+ - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 3.0.25
29
+ version: '4'
30
+ - !ruby/object:Gem::Dependency
31
+ name: sass
32
+ requirement: !ruby/object:Gem::Requirement
33
+ requirements:
34
+ - - ">="
35
+ - !ruby/object:Gem::Version
36
+ version: '0'
37
+ type: :runtime
38
+ prerelease: false
39
+ version_requirements: !ruby/object:Gem::Requirement
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ version: '0'
30
44
  - !ruby/object:Gem::Dependency
31
45
  name: rdoc
32
46
  requirement: !ruby/object:Gem::Requirement
33
47
  requirements:
34
- - - "~>"
48
+ - - ">="
35
49
  - !ruby/object:Gem::Version
36
- version: '4.0'
50
+ version: '4'
37
51
  type: :runtime
38
52
  prerelease: false
39
53
  version_requirements: !ruby/object:Gem::Requirement
40
54
  requirements:
41
- - - "~>"
55
+ - - ">="
42
56
  - !ruby/object:Gem::Version
43
- version: '4.0'
44
- description: ''
57
+ version: '4'
58
+ description: |
59
+ RDoc generator designed with simplicity, beauty and ease of browsing in mind
60
+
61
+ Based on the original Hanna by Mislav, with many changes so it works
62
+ on modern verions of RDoc, Haml, and Sass.
45
63
  email: code@jeremyevans.net
46
64
  executables: []
47
65
  extensions: []
@@ -49,7 +67,6 @@ extra_rdoc_files:
49
67
  - LICENSE
50
68
  - README.rdoc
51
69
  files:
52
- - Gemfile
53
70
  - LICENSE
54
71
  - README.rdoc
55
72
  - Rakefile
@@ -67,7 +84,7 @@ files:
67
84
  - lib/hanna-nouveau/template_files/sections.haml
68
85
  - lib/hanna-nouveau/template_files/styles.sass
69
86
  - lib/rdoc/discover.rb
70
- homepage: https://github.com/rdoc/hanna-nouveau
87
+ homepage: https://github.com/jeremyevans/hanna-nouveau
71
88
  licenses:
72
89
  - MIT
73
90
  metadata: {}
@@ -86,9 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
86
103
  - !ruby/object:Gem::Version
87
104
  version: '0'
88
105
  requirements: []
89
- rubyforge_project:
90
- rubygems_version: 2.2.2
106
+ rubygems_version: 3.1.2
91
107
  signing_key:
92
108
  specification_version: 4
93
- summary: A rework of the Hanna generator for RDoc 4
109
+ summary: RDoc generator designed with simplicity, beauty and ease of browsing in mind
94
110
  test_files: []
data/Gemfile DELETED
@@ -1,3 +0,0 @@
1
- source "http://rubygems.org"
2
- gem 'rdoc', "~> 4.0"
3
- gem 'haml', "= 3.0.25"