yard-dash 1.0.1 → 1.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 +8 -8
  2. data/README.md +18 -3
  3. data/lib/yard-dash/version.rb +1 -1
  4. metadata +5 -5
checksums.yaml CHANGED
@@ -1,15 +1,15 @@
1
1
  ---
2
2
  !binary "U0hBMQ==":
3
3
  metadata.gz: !binary |-
4
- NTViNmExMTNkZjhiZTZhODQ1YzgzMmRmY2EyY2JkMTlmOTQ0YWE2Mw==
4
+ NDgxMzQzMzYzYmQyYTY0Yjc5OWZmMTkyYmEyOWUxNDJjZDM4MTMyMQ==
5
5
  data.tar.gz: !binary |-
6
- ZWVhMDc5ZTQ2MjU3ZmFhMmRhZmMxN2ZmMTkzZDc4MTRjMDY0ZjM3NQ==
6
+ NWNlNDhmYzE0NzhkMjRlNjZjZGQ5YTE4NDVlNTA1NDI1YTg2ZmFhNA==
7
7
  SHA512:
8
8
  metadata.gz: !binary |-
9
- ZDFlMTNjOWU2MDc2NTA3NGRjZjYwMGRhNzUxYmRhM2Y3MzkxYTcwYjk2MzM2
10
- ZjE1OGM2Zjg4MDc5YjZiOWYwZTU0NTU0OGM0ZDZkMTE1ZTUyOTc5OGYxNDY4
11
- NmI1ZTJiNTA4YzJjMWFhNDIyNjcyZmQ2NzBkNTBmOTEwYTliNzU=
9
+ YjQ3MmRlOWU4MGQwMDk5YmVkYjg4NzA1ZmNmYTQ2ZTY4Nzk3Zjk4MzQ4Nzgx
10
+ OTQzMzc3NDQ4ZTI2YzhmMGNiNTE3MjlhZDFkOGYzMjcxMDcxNWExMTJhOTYx
11
+ Y2MwZmQ1YTU2MGJkNjhjMzhlZThhYTQyZTcyYjQ0ZjYwNmJkMjg=
12
12
  data.tar.gz: !binary |-
13
- OGE0NGE4N2VmMzM3YTI3ZDU2ODJkZTgyYmZiYjhiMDdhMjU1YWJkZDcyM2E1
14
- YjhhYTQyZGFhNzQ0MWJiYmNkNzE2NjI5YzkyM2YzMzRlZjk3MjEyZTljOTEw
15
- NTBlZmQ0NDU2YWU0MDQyMTgwODQ5NzA4OGZmNjViMDAxMDUxNDY=
13
+ YjU5OTg0NzlhYWVmNWVmNWJkODYxZGZjMDQyOTJkYTBiYmE2M2RjMzZkMWRj
14
+ OGM2ZDY1MDYwOGEyNmMwYzVkNTAyMDcyYjNiN2JkNmViOTUwYTRmMzQ5Yzdm
15
+ YmQ1YzdhNzNjOGE4Y2ZkOGU3ZDZkOTgzN2U2ODBlODNmZjYxYzA=
data/README.md CHANGED
@@ -1,6 +1,10 @@
1
1
  # yard-dash
2
2
 
3
- This `yard` plugin will generate a `Dash` **dockset** in addition to the normal HTML directory for a gem. The HTML code is copied from the standard yard source and is unchanged.
3
+ This `yard` plugin will generate a `Dash` **dockset** for a *Gem* in addition to the normal `HTML` *doc* directory.
4
+
5
+ This plugin piggybacks on the standard `HTML` generation code from `Yard` by injecting a callback that will take care of the generation.
6
+
7
+ Just for the record the original code in `Yard` is unchanged.
4
8
 
5
9
  ## Installation
6
10
 
@@ -20,7 +24,18 @@ Or install it yourself as:
20
24
 
21
25
  ## Usage
22
26
 
23
- Just run `yardoc` and the **dockset** will be created on top off the standard HTML tree.
24
- The name of the gem inside **dockset** will be defined by the name inside the `gemspec` file.
27
+ Just run `yardoc` and the **dockset** will be created in addition to the standard HTML tree in the `doc` directory.
28
+
29
+ The **dockset** will get the same name as the *name* in the `gemspec`.
30
+
31
+
32
+ ```ruby
33
+ Gem::Specification.new do |s|
34
+ s.name = 'gemexample'
35
+ ...
36
+ end
37
+ ```
38
+
39
+ Given the above specification the **dockset** will get the name `gemexample.docset`.
25
40
 
26
41
 
@@ -7,5 +7,5 @@
7
7
  module YardDashVersion
8
8
  #
9
9
  # @return [String] The application version number
10
- NUMBER = "1.0.1"
10
+ NUMBER = "1.0.2"
11
11
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard-dash
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.1
4
+ version: 1.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Fred Appelman
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-06-17 00:00:00.000000000 Z
11
+ date: 2015-06-18 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: Yard-dash generates a docset for Dash
14
14
  email: fred@appelman.net
@@ -21,7 +21,7 @@ files:
21
21
  - lib/yard-dash/base_helper.rb
22
22
  - lib/yard-dash/setup.rb
23
23
  - lib/yard-dash/version.rb
24
- homepage: http://fred.appelman.net
24
+ homepage: https://bitbucket.org/fappelman/yard-dash
25
25
  licenses:
26
26
  - (c) MIT
27
27
  metadata: {}
@@ -31,9 +31,9 @@ require_paths:
31
31
  - lib
32
32
  required_ruby_version: !ruby/object:Gem::Requirement
33
33
  requirements:
34
- - - ! '>='
34
+ - - ~>
35
35
  - !ruby/object:Gem::Version
36
- version: '0'
36
+ version: 1.9.3
37
37
  required_rubygems_version: !ruby/object:Gem::Requirement
38
38
  requirements:
39
39
  - - ! '>='