rubygems-yardoc 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/README.markdown +9 -22
- data/lib/rubygems/commands/yardoc_command.rb +9 -10
- data/lib/rubygems_plugin.rb +19 -0
- data/rubygems-yardoc.gemspec +4 -3
- metadata +45 -23
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 0274adef59e1ec7f54d5417c70b211539a4bf656
|
4
|
+
data.tar.gz: 380233675e69e53276f8ac4af05e92c389c1e367
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c95c18db2625a0c0d6d2d0e4e3e1589ae0795637e938d9e7cfd8dec1a6d94303748dbc0dfd889a60754f5d6a9a120b8d2917687cf6269a531938ba10e3e520bb
|
7
|
+
data.tar.gz: 39b0165b019a2b38c57dbde93174e25e09ea7eb1a08f881b82d9c07190c1d06e81a31f7e5afbc377f3bd49648418b35726570a3e76254506df1e291bd57c8eda
|
data/README.markdown
CHANGED
@@ -6,40 +6,25 @@ This gem provides `gem yardoc` command which generates YARD documentations for s
|
|
6
6
|
Installation
|
7
7
|
------------
|
8
8
|
|
9
|
-
Add this line to your application's Gemfile:
|
10
|
-
|
11
|
-
gem 'rubygems-yardoc'
|
12
|
-
|
13
|
-
And then execute:
|
14
|
-
|
15
|
-
$ bundle
|
16
|
-
|
17
|
-
Or install it yourself as:
|
18
|
-
|
19
9
|
$ gem install rubygems-yardoc
|
20
10
|
|
21
|
-
Installing
|
22
|
-
|
23
|
-
gem 'recarpet'
|
24
|
-
|
25
|
-
And executing:
|
26
|
-
|
27
|
-
$ bundle
|
28
|
-
|
29
|
-
Or just executing:
|
11
|
+
Installing [Redcarpet][1] by:
|
30
12
|
|
31
13
|
$ gem install redcarpet
|
32
14
|
|
33
15
|
often helps you because many gems use Markdown to write README files
|
34
|
-
and YARD
|
16
|
+
and YARD requires Redcarpet when parsing Markdown.
|
35
17
|
|
36
18
|
Usage
|
37
19
|
-----
|
38
20
|
|
39
21
|
$ gem yardoc GEMNAME [GEMNAME ...]
|
40
22
|
|
41
|
-
|
42
|
-
YARD Documentation for the gem will be generated into the directory
|
23
|
+
Makes `yardoc` directory into specified gem's doc directory and
|
24
|
+
YARD Documentation for the gem will be generated into the directory.
|
25
|
+
|
26
|
+
And this gem add `--yardoc` option to `gem install` command
|
27
|
+
which install YARD documentation.
|
43
28
|
|
44
29
|
Contributing
|
45
30
|
------------
|
@@ -49,3 +34,5 @@ Contributing
|
|
49
34
|
3. Commit your changes (`git commit -am 'Add some feature'`)
|
50
35
|
4. Push to the branch (`git push origin my-new-feature`)
|
51
36
|
5. Create new Pull Request
|
37
|
+
|
38
|
+
[1]: https://github.com/vmg/redcarpet
|
@@ -3,8 +3,6 @@ require 'rubygems/command'
|
|
3
3
|
require 'yard'
|
4
4
|
|
5
5
|
class Gem::Commands::YardocCommand < Gem::Command
|
6
|
-
VERSION = '0.0.2'
|
7
|
-
|
8
6
|
def initialize
|
9
7
|
super 'yardoc', 'Generate YARD documentations for specified gems into doc directory'
|
10
8
|
end
|
@@ -19,17 +17,18 @@ class Gem::Commands::YardocCommand < Gem::Command
|
|
19
17
|
|
20
18
|
def execute
|
21
19
|
get_all_gem_names.each do |name|
|
22
|
-
run_yardoc name
|
20
|
+
self.class.run_yardoc Gem::Specification.find_by_name(name)
|
23
21
|
end
|
24
22
|
end
|
25
23
|
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
24
|
+
class << self
|
25
|
+
def run_yardoc(spec)
|
26
|
+
yardoc_dir = File.join(spec.doc_dir, 'yardoc')
|
27
|
+
Dir.chdir spec.gem_dir do
|
28
|
+
YARD::CLI::Yardoc.run '--output-dir', yardoc_dir
|
29
|
+
end
|
30
|
+
$stderr.puts 'YARD documentation is generated to:'
|
31
|
+
$stderr.puts yardoc_dir
|
31
32
|
end
|
32
|
-
$stderr.puts 'YARD documentation is generated in:'
|
33
|
-
$stderr.puts yardoc_dir
|
34
33
|
end
|
35
34
|
end
|
data/lib/rubygems_plugin.rb
CHANGED
@@ -1,3 +1,22 @@
|
|
1
1
|
require 'rubygems/command_manager'
|
2
|
+
require 'rubygems/install_update_options'
|
3
|
+
require 'rubygems/commands/yardoc_command'
|
2
4
|
|
3
5
|
Gem::CommandManager.instance.register_command :yardoc
|
6
|
+
|
7
|
+
module Gem::InstallUpdateOptions
|
8
|
+
alias install_update_options_without_yardoc add_install_update_options
|
9
|
+
def add_install_update_options
|
10
|
+
install_update_options_without_yardoc
|
11
|
+
|
12
|
+
add_option 'Install/Update', '--yardoc', 'Generate YARD documentation for installed gems' do |value, option|
|
13
|
+
unless options[:document].include? 'yardoc'
|
14
|
+
options[:document] << 'yardoc'
|
15
|
+
|
16
|
+
Gem.post_install do |installer|
|
17
|
+
Gem::Commands::YardocCommand.run_yardoc(installer.spec)
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
data/rubygems-yardoc.gemspec
CHANGED
@@ -1,24 +1,25 @@
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
2
2
|
lib = File.expand_path('../lib', __FILE__)
|
3
3
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
-
require 'rubygems/commands/yardoc_command'
|
5
4
|
|
6
5
|
Gem::Specification.new do |gem|
|
7
6
|
gem.name = "rubygems-yardoc"
|
8
|
-
gem.version =
|
7
|
+
gem.version = '0.0.3'
|
9
8
|
gem.authors = ["KITAITI Makoto"]
|
10
9
|
gem.email = ["KitaitiMakoto@gmail.com"]
|
11
10
|
gem.description = %q{Provides a "gem yardoc" command which generates YARD documentations for specified gems}
|
12
11
|
gem.summary = %q{gem yardoc command-line tool}
|
13
12
|
gem.homepage = "https://github.com/KitaitiMakoto/rubygems-yardoc"
|
13
|
+
gem.license = 'MIT'
|
14
14
|
|
15
15
|
gem.files = `git ls-files`.split($/)
|
16
16
|
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
17
17
|
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
18
18
|
gem.require_paths = ["lib"]
|
19
19
|
|
20
|
-
gem.add_runtime_dependency 'yard'
|
20
|
+
gem.add_runtime_dependency 'yard', '~> 0.8.5'
|
21
21
|
|
22
22
|
gem.add_development_dependency 'bundler'
|
23
|
+
gem.add_development_dependency 'rake'
|
23
24
|
gem.add_development_dependency 'redcarpet'
|
24
25
|
end
|
metadata
CHANGED
@@ -1,49 +1,71 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rubygems-yardoc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
5
|
-
prerelease:
|
4
|
+
version: 0.0.3
|
6
5
|
platform: ruby
|
7
6
|
authors:
|
8
7
|
- KITAITI Makoto
|
9
8
|
autorequire:
|
10
9
|
bindir: bin
|
11
10
|
cert_chain: []
|
12
|
-
date: 2013-01
|
11
|
+
date: 2013-03-01 00:00:00.000000000 Z
|
13
12
|
dependencies:
|
14
13
|
- !ruby/object:Gem::Dependency
|
15
14
|
name: yard
|
16
|
-
requirement:
|
17
|
-
none: false
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
18
16
|
requirements:
|
19
|
-
- -
|
17
|
+
- - ~>
|
20
18
|
- !ruby/object:Gem::Version
|
21
|
-
version:
|
19
|
+
version: 0.8.5
|
22
20
|
type: :runtime
|
23
21
|
prerelease: false
|
24
|
-
version_requirements:
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.8.5
|
25
27
|
- !ruby/object:Gem::Dependency
|
26
28
|
name: bundler
|
27
|
-
requirement:
|
28
|
-
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
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: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
29
44
|
requirements:
|
30
|
-
- -
|
45
|
+
- - '>='
|
31
46
|
- !ruby/object:Gem::Version
|
32
47
|
version: '0'
|
33
48
|
type: :development
|
34
49
|
prerelease: false
|
35
|
-
version_requirements:
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
36
55
|
- !ruby/object:Gem::Dependency
|
37
56
|
name: redcarpet
|
38
|
-
requirement:
|
39
|
-
none: false
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
40
58
|
requirements:
|
41
|
-
- -
|
59
|
+
- - '>='
|
42
60
|
- !ruby/object:Gem::Version
|
43
61
|
version: '0'
|
44
62
|
type: :development
|
45
63
|
prerelease: false
|
46
|
-
version_requirements:
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - '>='
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
47
69
|
description: Provides a "gem yardoc" command which generates YARD documentations for
|
48
70
|
specified gems
|
49
71
|
email:
|
@@ -60,28 +82,28 @@ files:
|
|
60
82
|
- lib/rubygems_plugin.rb
|
61
83
|
- rubygems-yardoc.gemspec
|
62
84
|
homepage: https://github.com/KitaitiMakoto/rubygems-yardoc
|
63
|
-
licenses:
|
85
|
+
licenses:
|
86
|
+
- MIT
|
87
|
+
metadata: {}
|
64
88
|
post_install_message:
|
65
89
|
rdoc_options: []
|
66
90
|
require_paths:
|
67
91
|
- lib
|
68
92
|
required_ruby_version: !ruby/object:Gem::Requirement
|
69
|
-
none: false
|
70
93
|
requirements:
|
71
|
-
- -
|
94
|
+
- - '>='
|
72
95
|
- !ruby/object:Gem::Version
|
73
96
|
version: '0'
|
74
97
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
75
|
-
none: false
|
76
98
|
requirements:
|
77
|
-
- -
|
99
|
+
- - '>='
|
78
100
|
- !ruby/object:Gem::Version
|
79
101
|
version: '0'
|
80
102
|
requirements: []
|
81
103
|
rubyforge_project:
|
82
|
-
rubygems_version:
|
104
|
+
rubygems_version: 2.0.0
|
83
105
|
signing_key:
|
84
|
-
specification_version:
|
106
|
+
specification_version: 4
|
85
107
|
summary: gem yardoc command-line tool
|
86
108
|
test_files: []
|
87
109
|
has_rdoc:
|