horo 1.0.0.beta.1 → 1.0.0.beta.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. data/README.rdoc +22 -3
  2. data/Rakefile +1 -0
  3. data/lib/horo.rb +1 -1
  4. metadata +24 -9
data/README.rdoc CHANGED
@@ -9,15 +9,34 @@ style and format used for Ruby on Rails API documentation.
9
9
 
10
10
  == FEATURES/PROBLEMS:
11
11
 
12
- * Not done yet
12
+ * May have bugs?
13
13
 
14
14
  == SYNOPSIS:
15
15
 
16
- FIX (code sample of usage)
16
+ You can output Horo formatted documentation from the command line like this:
17
+
18
+ $ sudo gem install horo
19
+ $ cd ~/git/nokogiri
20
+ $ rdoc -f horo --main README.rdoc *.rdoc lib ext
21
+
22
+ Here is an example rake task that uses the Horo format:
23
+
24
+ RDoc::Task.new do |rdoc|
25
+ rdoc.title = "My Awesome docs"
26
+ rdoc.rdoc_dir = 'doc'
27
+
28
+ rdoc.options << '-f' << 'horo'
29
+ rdoc.options << '--main' << 'README'
30
+ end
31
+
32
+ The important part is that you have the "horo" gem installed and that you pass
33
+ the "-f horo" option. That tells RDoc to use the Horo format when generating
34
+ your documentation.
17
35
 
18
36
  == REQUIREMENTS:
19
37
 
20
- * FIX (list of requirements)
38
+ * Ruby
39
+ * RDoc 2.5.x
21
40
 
22
41
  == INSTALL:
23
42
 
data/Rakefile CHANGED
@@ -8,6 +8,7 @@ Hoe.spec 'horo' do
8
8
  self.readme_file = 'README.rdoc'
9
9
  self.history_file = 'CHANGELOG.rdoc'
10
10
  self.extra_rdoc_files = FileList['*.rdoc']
11
+ self.extra_deps << ['rdoc', '~> 2.5']
11
12
  self.extra_dev_deps << ['nokogiri', '>= 1.4.2']
12
13
  end
13
14
 
data/lib/horo.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Horo
2
- VERSION = '1.0.0.beta.1'
2
+ VERSION = '1.0.0.beta.2'
3
3
  end
metadata CHANGED
@@ -1,15 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: horo
3
3
  version: !ruby/object:Gem::Version
4
- hash: 62196353
4
+ hash: 62196359
5
5
  prerelease: true
6
6
  segments:
7
7
  - 1
8
8
  - 0
9
9
  - 0
10
10
  - beta
11
- - 1
12
- version: 1.0.0.beta.1
11
+ - 2
12
+ version: 1.0.0.beta.2
13
13
  platform: ruby
14
14
  authors:
15
15
  - Aaron Patterson
@@ -21,9 +21,24 @@ date: 2010-07-14 00:00:00 -07:00
21
21
  default_executable:
22
22
  dependencies:
23
23
  - !ruby/object:Gem::Dependency
24
- name: rubyforge
24
+ name: rdoc
25
25
  prerelease: false
26
26
  requirement: &id001 !ruby/object:Gem::Requirement
27
+ none: false
28
+ requirements:
29
+ - - ~>
30
+ - !ruby/object:Gem::Version
31
+ hash: 9
32
+ segments:
33
+ - 2
34
+ - 5
35
+ version: "2.5"
36
+ type: :runtime
37
+ version_requirements: *id001
38
+ - !ruby/object:Gem::Dependency
39
+ name: rubyforge
40
+ prerelease: false
41
+ requirement: &id002 !ruby/object:Gem::Requirement
27
42
  none: false
28
43
  requirements:
29
44
  - - ">="
@@ -35,11 +50,11 @@ dependencies:
35
50
  - 4
36
51
  version: 2.0.4
37
52
  type: :development
38
- version_requirements: *id001
53
+ version_requirements: *id002
39
54
  - !ruby/object:Gem::Dependency
40
55
  name: nokogiri
41
56
  prerelease: false
42
- requirement: &id002 !ruby/object:Gem::Requirement
57
+ requirement: &id003 !ruby/object:Gem::Requirement
43
58
  none: false
44
59
  requirements:
45
60
  - - ">="
@@ -51,11 +66,11 @@ dependencies:
51
66
  - 2
52
67
  version: 1.4.2
53
68
  type: :development
54
- version_requirements: *id002
69
+ version_requirements: *id003
55
70
  - !ruby/object:Gem::Dependency
56
71
  name: hoe
57
72
  prerelease: false
58
- requirement: &id003 !ruby/object:Gem::Requirement
73
+ requirement: &id004 !ruby/object:Gem::Requirement
59
74
  none: false
60
75
  requirements:
61
76
  - - ">="
@@ -67,7 +82,7 @@ dependencies:
67
82
  - 0
68
83
  version: 2.6.0
69
84
  type: :development
70
- version_requirements: *id003
85
+ version_requirements: *id004
71
86
  description: |-
72
87
  An RDoc template extracted from Ruby on Rails. Provides the same documetation
73
88
  style and format used for Ruby on Rails API documentation.