bootstrap-rdoc 0.2

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 (4) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +19 -0
  3. data/README.rdoc +74 -0
  4. metadata +146 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 08a6d52ed182ececcc066fc91b8e42da95a8e108
4
+ data.tar.gz: a2b5503e9e17255f16740ac0a4d08cf893a5c0e8
5
+ SHA512:
6
+ metadata.gz: 502387e297f5280e5ea2ba7211386d59eb55d1ddcac2bfdc6db5ccda1575bd2bb5b8471685de65994515d1edbc38e9058f96cd18525f43d88cb27c80787608a3
7
+ data.tar.gz: c7c154dcca2cac1d0657c0f300c892203148352be6cd4bbf4636a3be26f58063e5a6f91266a0e16ff4aa8ac7e630f1d869b6ac8168825d89181be24c15e51ac7
data/LICENSE ADDED
@@ -0,0 +1,19 @@
1
+ Copyright (c) 2009 Mislav Marohnić
2
+ Copyright (c) 2010, 2011 Erik Hollensbe
3
+
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
5
+ this software and associated documentation files (the "Software"), to deal in
6
+ the Software without restriction, including without limitation the rights to
7
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
8
+ the Software, and to permit persons to whom the Software is furnished to do so,
9
+ subject to the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be included in all
12
+ copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
16
+ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
17
+ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
18
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,74 @@
1
+ = Hanna Bootstrap — Twitter Bootstrap theme for RDoc
2
+
3
+ Based on the original Hanna by Mislav, Hanna Nouveau by Erik.
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].)
9
+
10
+ Hanna gem is available from http://rubygems.org:
11
+
12
+ gem install hanna-bootstrap
13
+
14
+ The template was created by {Atsushi Nagase}[http://ngs.io/] and since then
15
+ has seen contributions from:
16
+
17
+ == Usage
18
+
19
+ rdoc -o doc -f bootstrap lib/*.rb
20
+
21
+ An alternative is to set the `RDOCOPT` environment variable:
22
+
23
+ RDOCOPT="-f bootstrap"
24
+
25
+ This will make RDoc always use Hanna unless it is explicitly overridden.
26
+
27
+ == Integrating with RubyGems
28
+
29
+ Another neat trick is to put the following line in your .gemrc, this will make
30
+ RubyGems use Hanna for all rdoc generation:
31
+
32
+ rdoc: -f bootstrap
33
+
34
+ This will make RubyGems use Hanna when generating documentation for installed
35
+ gems. Remember, if you wish to have all your gems be formatted in bootstrap:
36
+
37
+ gem rdoc --all --overwrite
38
+
39
+ The first time. To easily browse your newly created documentation, use:
40
+
41
+ gem server
42
+
43
+ == Rake task
44
+
45
+ For repeated generation of API docs, it's better to set up a Rake task. Simply
46
+ add the bootstrap format argument to your RDoc::Task options:
47
+
48
+ gem 'rdoc'
49
+ require 'rdoc/task'
50
+ RDoc::Task.new do |rdoc|
51
+ # this only works with RDoc 3.1 or greater
52
+ rdoc.generator = 'bootstrap'
53
+ # this is what you use pre RDoc 3.1:
54
+ rdoc.options.push '-f', 'bootstrap'
55
+ end
56
+
57
+ Tip: you can do this in the Rakefile of your Rails project before running
58
+ `rake doc:rails`.
59
+
60
+ Here is an example of a task for the {rdbi
61
+ library}[http://github.com/rdbi/rdbi/tree/master/Rakefile]:
62
+
63
+ gem 'rdoc'
64
+ require 'rdoc/task'
65
+ RDoc::Task.new do |rdoc|
66
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
67
+
68
+ rdoc.generator = 'bootstrap'
69
+ rdoc.main = 'README.rdoc'
70
+ rdoc.rdoc_dir = 'rdoc'
71
+ rdoc.title = "RDBI #{version} Documentation"
72
+ rdoc.rdoc_files.include('README*')
73
+ rdoc.rdoc_files.include('lib/**/*.rb')
74
+ end
metadata ADDED
@@ -0,0 +1,146 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: bootstrap-rdoc
3
+ version: !ruby/object:Gem::Version
4
+ version: '0.2'
5
+ platform: ruby
6
+ authors:
7
+ - Matt Ruocco
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-07-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '>='
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '>='
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: coderay
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: coffee-script
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
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: haml
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '>='
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: json
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - '>='
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - '>='
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rake
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - '>='
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - '>='
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: sass
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - '>='
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :runtime
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - '>='
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ description: ''
112
+ email: ''
113
+ executables: []
114
+ extensions: []
115
+ extra_rdoc_files:
116
+ - LICENSE
117
+ - README.rdoc
118
+ files:
119
+ - LICENSE
120
+ - README.rdoc
121
+ homepage: ''
122
+ licenses:
123
+ - MIT
124
+ metadata: {}
125
+ post_install_message:
126
+ rdoc_options: []
127
+ require_paths:
128
+ - lib
129
+ required_ruby_version: !ruby/object:Gem::Requirement
130
+ requirements:
131
+ - - '>='
132
+ - !ruby/object:Gem::Version
133
+ version: '0'
134
+ required_rubygems_version: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - '>='
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ requirements: []
140
+ rubyforge_project:
141
+ rubygems_version: 2.2.2
142
+ signing_key:
143
+ specification_version: 4
144
+ summary: Twitter Boostrap theme for RDoc
145
+ test_files: []
146
+ has_rdoc: