mgreenly-mygemdocs 0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +19 -0
- data/README.rdoc +24 -0
- data/Rakefile +9 -0
- data/bin/mygemdocs +29 -0
- data/mygemdocs.gemspec +17 -0
- metadata +67 -0
data/LICENSE
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
Copyright (c) Michael A. Greenly <mgreenly@gmail.com>
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
4
|
+
of this software and associated documentation files (the "Software"), to deal
|
5
|
+
in the Software without restriction, including without limitation the rights
|
6
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
7
|
+
copies of the Software, and to permit persons to whom the Software is
|
8
|
+
furnished to do so, subject to the following conditions:
|
9
|
+
|
10
|
+
The above copyright notice and this permission notice shall be included in
|
11
|
+
all copies or substantial portions of the Software.
|
12
|
+
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
14
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
15
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
16
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
17
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
18
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
19
|
+
THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
== MyGemDocs
|
2
|
+
|
3
|
+
This is a ugly little script that generates an html index file for any installed
|
4
|
+
gems that already have rdocs generated. Typically I'd do something like this...
|
5
|
+
|
6
|
+
gem rdoc --all
|
7
|
+
mygemdocs > $HOME/.mygemdocs.html
|
8
|
+
firefox $HOME/.mygemdocs.html
|
9
|
+
|
10
|
+
Then bookmark the paged.
|
11
|
+
|
12
|
+
== Installation
|
13
|
+
|
14
|
+
This ugly little script is available as a gem from git hub.
|
15
|
+
|
16
|
+
$ gem sources -a http://gems.github.com/ (you only need to do this once ever)
|
17
|
+
$ [sudo] gem install mgreenly-mygemdocs
|
18
|
+
|
19
|
+
== TODO
|
20
|
+
|
21
|
+
It should be turned into a real application that builds an rdoc index of all locally
|
22
|
+
installed ruby resources, the core library, standard library and gem library.
|
23
|
+
|
24
|
+
It should also be smart enough not to regenerate documentation that's up to date.
|
data/Rakefile
ADDED
data/bin/mygemdocs
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require 'rubygems'
|
4
|
+
|
5
|
+
puts <<EOS
|
6
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
7
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
|
8
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
9
|
+
<head>
|
10
|
+
<title>MyGemDocs</title>
|
11
|
+
</head>
|
12
|
+
<body>
|
13
|
+
<ul>
|
14
|
+
EOS
|
15
|
+
|
16
|
+
Gem.path.each do |gempath|
|
17
|
+
Dir[ gempath + "/doc/*"].sort.each do |doc|
|
18
|
+
if File.exists?(doc + "/rdoc/index.html")
|
19
|
+
puts %Q{<li><a href="file://#{doc}/rdoc/index.html">#{File.basename(doc)}</a></li>}
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
puts <<EOS
|
25
|
+
</ul>
|
26
|
+
</body>
|
27
|
+
</html>
|
28
|
+
EOS
|
29
|
+
|
data/mygemdocs.gemspec
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
Gem::Specification.new do |s|
|
2
|
+
s.name = "mygemdocs"
|
3
|
+
s.version = "0.1"
|
4
|
+
s.date = "2008-04-26"
|
5
|
+
s.summary = "generates an html index to the installed rdocs"
|
6
|
+
s.email = "mgreenly@gmail.com"
|
7
|
+
s.homepage = "http://github.com/mgreenly/mygemdocs/tree/master"
|
8
|
+
s.description = "Generates an html index of rdocs for installed gems"
|
9
|
+
s.has_rdoc = true
|
10
|
+
s.bindir = "bin"
|
11
|
+
s.executables = ["mygemdocs"]
|
12
|
+
s.authors = ["Michael Greenly"]
|
13
|
+
s.files = ["bin/mygemdocs", "LICENSE", "Rakefile", "README.rdoc", "mygemdocs.gemspec"]
|
14
|
+
s.rdoc_options = ["--main", "README.rdoc"]
|
15
|
+
s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
|
16
|
+
s.add_dependency("mime-types", ["> 0.0.0"])
|
17
|
+
end
|
metadata
ADDED
@@ -0,0 +1,67 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: mgreenly-mygemdocs
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: "0.1"
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Michael Greenly
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2008-04-26 00:00:00 -07:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: mime-types
|
17
|
+
version_requirement:
|
18
|
+
version_requirements: !ruby/object:Gem::Requirement
|
19
|
+
requirements:
|
20
|
+
- - ">"
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 0.0.0
|
23
|
+
version:
|
24
|
+
description: Generates an html index of rdocs for installed gems
|
25
|
+
email: mgreenly@gmail.com
|
26
|
+
executables:
|
27
|
+
- mygemdocs
|
28
|
+
extensions: []
|
29
|
+
|
30
|
+
extra_rdoc_files:
|
31
|
+
- README.rdoc
|
32
|
+
- LICENSE
|
33
|
+
files:
|
34
|
+
- bin/mygemdocs
|
35
|
+
- LICENSE
|
36
|
+
- Rakefile
|
37
|
+
- README.rdoc
|
38
|
+
- mygemdocs.gemspec
|
39
|
+
has_rdoc: true
|
40
|
+
homepage: http://github.com/mgreenly/mygemdocs/tree/master
|
41
|
+
post_install_message:
|
42
|
+
rdoc_options:
|
43
|
+
- --main
|
44
|
+
- README.rdoc
|
45
|
+
require_paths:
|
46
|
+
- lib
|
47
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
48
|
+
requirements:
|
49
|
+
- - ">="
|
50
|
+
- !ruby/object:Gem::Version
|
51
|
+
version: "0"
|
52
|
+
version:
|
53
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
54
|
+
requirements:
|
55
|
+
- - ">="
|
56
|
+
- !ruby/object:Gem::Version
|
57
|
+
version: "0"
|
58
|
+
version:
|
59
|
+
requirements: []
|
60
|
+
|
61
|
+
rubyforge_project:
|
62
|
+
rubygems_version: 1.0.1
|
63
|
+
signing_key:
|
64
|
+
specification_version: 2
|
65
|
+
summary: generates an html index to the installed rdocs
|
66
|
+
test_files: []
|
67
|
+
|