yard-markdown 0.3.5 → 0.3.6

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c227b04d5aa3f58fc394afa96321c60f39d9975145476f5f7ac53453f5d58b29
4
- data.tar.gz: a55a8c70d0afcdfe7a540e74f24922bc31ac161740576afee9d5e5d18bac318a
3
+ metadata.gz: f5523cfc6cf6adb6b59889cd2e0d6bfc77c1fb52383082e3c9301e0844a2d560
4
+ data.tar.gz: 0fe11f9cae202f92339a483944ec2ef5fa8f7691df97956ebe25a94ceaf1d754
5
5
  SHA512:
6
- metadata.gz: fe9dd35f306722d000d1fbc1271f526c9f80698ee5ee223d17f94a36a1ca315734d183745674d5cb2e42a470454d2cc6879ac8bbbb0b8f1a3e6902571de0a4e0
7
- data.tar.gz: 19f382bc86ef7722f92f520129bb0d7ddda7b8ecd3b6f8214ee663c5397eb102b866c2ad73f9a4d7250f89748f3fbf540cb20f164d6fb7b2c44fc2e104a78a81
6
+ metadata.gz: 72da1d6db9b4973eece057cf270a2a51bed95755b02a99aac9f17bbdc4ad77d6dd5446be046851c1c03d3905815205f7aed708c98b0ae989202f15fc44710aff
7
+ data.tar.gz: 643b0905f46830b7108ea6fa9021ff3306679ed534b6e294cd02e0d069ad1cce3bca04a190ea20c8344f7ee3bf2f97a479044d5519e9b027a9806d22c2dab16d
data/example/index.csv CHANGED
@@ -1,21 +1,21 @@
1
1
  name,type,path
2
2
  Waterfowl,Module,Waterfowl.md
3
- DEFAULT_DUCK_VELOCITY,Constant,Waterfowl.md#constant-DEFAULT_DUCK_VELOCITY
4
- DEFAULT_SPEED,Constant,Waterfowl.md#constant-DEFAULT_SPEED
5
- swim,Method,Waterfowl.md#method-i-swim
3
+ Waterfowl#DEFAULT_DUCK_VELOCITY,Constant,Waterfowl.md#constant-DEFAULT_DUCK_VELOCITY
4
+ Waterfowl#DEFAULT_SPEED,Constant,Waterfowl.md#constant-DEFAULT_SPEED
5
+ Waterfowl.swim,Method,Waterfowl.md#method-i-swim
6
6
  Bird,Class,Bird.md
7
- DEFAULT_DUCK_VELOCITY,Constant,Bird.md#constant-DEFAULT_DUCK_VELOCITY
8
- DEFAULT_SPEED,Constant,Bird.md#constant-DEFAULT_SPEED
9
- _fly_impl,Method,Bird.md#method-i-_fly_impl
10
- fly,Method,Bird.md#method-i-fly
11
- speak,Method,Bird.md#method-i-speak
7
+ Bird#DEFAULT_DUCK_VELOCITY,Constant,Bird.md#constant-DEFAULT_DUCK_VELOCITY
8
+ Bird#DEFAULT_SPEED,Constant,Bird.md#constant-DEFAULT_SPEED
9
+ Bird._fly_impl,Method,Bird.md#method-i-_fly_impl
10
+ Bird.fly,Method,Bird.md#method-i-fly
11
+ Bird.speak,Method,Bird.md#method-i-speak
12
12
  Duck,Class,Duck.md
13
- DEFAULT_DUCK_VELOCITY,Constant,Duck.md#constant-DEFAULT_DUCK_VELOCITY
14
- DEFAULT_SPEED,Constant,Duck.md#constant-DEFAULT_SPEED
15
- initialize,Method,Duck.md#method-i-initialize
16
- speak,Method,Duck.md#method-i-speak
17
- swim,Method,Duck.md#method-i-swim
18
- useful?,Method,Duck.md#method-i-useful?
19
- rubber_ducks,Method,Duck.md#method-c-rubber_ducks
13
+ Duck#DEFAULT_DUCK_VELOCITY,Constant,Duck.md#constant-DEFAULT_DUCK_VELOCITY
14
+ Duck#DEFAULT_SPEED,Constant,Duck.md#constant-DEFAULT_SPEED
15
+ Duck.initialize,Method,Duck.md#method-i-initialize
16
+ Duck.speak,Method,Duck.md#method-i-speak
17
+ Duck.swim,Method,Duck.md#method-i-swim
18
+ Duck.useful?,Method,Duck.md#method-i-useful?
19
+ Duck.rubber_ducks,Method,Duck.md#method-c-rubber_ducks
20
20
  domestic,Attribute,Duck.md#attribute-i-domestic
21
21
  rubber,Attribute,Duck.md#attribute-i-rubber
@@ -50,7 +50,7 @@ def serialize_index(objects)
50
50
  if constant_listing.size.positive?
51
51
  constant_listing.each do |cnst|
52
52
  csv << [
53
- cnst.name(false),
53
+ "#{object.path}.#{cnst.name(false)}",
54
54
  "Constant",
55
55
  (options.serializer.serialized_path(object) + "#" + aref(cnst)),
56
56
  ]
@@ -60,7 +60,7 @@ def serialize_index(objects)
60
60
  if (insmeths = public_instance_methods(object)).size > 0
61
61
  insmeths.each do |item|
62
62
  csv << [
63
- item.name(false),
63
+ "#{object.path}.#{item.name(false)}",
64
64
  "Method",
65
65
  options.serializer.serialized_path(object) + "#" + aref(item),
66
66
  ]
@@ -70,7 +70,7 @@ def serialize_index(objects)
70
70
  if (pubmeths = public_class_methods(object)).size > 0
71
71
  pubmeths.each do |item|
72
72
  csv << [
73
- item.name(false),
73
+ "#{object.path}.#{item.name(false)}",
74
74
  "Method",
75
75
  options.serializer.serialized_path(object) + "#" + aref(item),
76
76
  ]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard-markdown
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.5
4
+ version: 0.3.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stanislav (Stas) Katkov
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2024-08-25 00:00:00.000000000 Z
11
+ date: 2024-09-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: yard
@@ -24,6 +24,20 @@ dependencies:
24
24
  - - ">="
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: csv
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'
27
41
  description: yard plugin to generate markdown documentation for gems
28
42
  email:
29
43
  - yard-markdown@skatkov.com
@@ -41,8 +55,6 @@ files:
41
55
  - example/Bird.md
42
56
  - example/Duck.md
43
57
  - example/Waterfowl.md
44
- - example/YARD.md
45
- - example/YARD/Markdown.md
46
58
  - example/index.csv
47
59
  - lib/yard-markdown.rb
48
60
  - sig/yard/markdown.rbs
@@ -68,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
68
80
  - !ruby/object:Gem::Version
69
81
  version: '0'
70
82
  requirements: []
71
- rubygems_version: 3.5.17
83
+ rubygems_version: 3.5.9
72
84
  signing_key:
73
85
  specification_version: 4
74
86
  summary: yard plugin to generate markdown documentation
@@ -1,10 +0,0 @@
1
- # Module: YARD::Markdown
2
- | | |
3
- | -----------------: | :----- |
4
- | **Defined in:** | lib/yard-markdown.rb |
5
-
6
-
7
-
8
-
9
-
10
-
data/example/YARD.md DELETED
@@ -1,10 +0,0 @@
1
- # Module: YARD
2
- | | |
3
- | -----------------: | :----- |
4
- | **Defined in:** | lib/yard-markdown.rb |
5
-
6
-
7
-
8
-
9
-
10
-