yard-markdown 0.3.3 → 0.3.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Rakefile +0 -4
- data/example/YARD/Markdown.md +10 -0
- data/example/YARD.md +10 -0
- data/templates/default/fulldoc/markdown/setup.rb +5 -3
- metadata +6 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c227b04d5aa3f58fc394afa96321c60f39d9975145476f5f7ac53453f5d58b29
|
4
|
+
data.tar.gz: a55a8c70d0afcdfe7a540e74f24922bc31ac161740576afee9d5e5d18bac318a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fe9dd35f306722d000d1fbc1271f526c9f80698ee5ee223d17f94a36a1ca315734d183745674d5cb2e42a470454d2cc6879ac8bbbb0b8f1a3e6902571de0a4e0
|
7
|
+
data.tar.gz: 19f382bc86ef7722f92f520129bb0d7ddda7b8ecd3b6f8214ee663c5397eb102b866c2ad73f9a4d7250f89748f3fbf540cb20f164d6fb7b2c44fc2e104a78a81
|
data/Rakefile
CHANGED
data/example/YARD.md
ADDED
@@ -101,7 +101,7 @@ def serialize(object)
|
|
101
101
|
**<%= name %>:** <%= mix.sort_by {|o| o.path }.join(", ") %>
|
102
102
|
<% end %><% end %>
|
103
103
|
<% unless object.root? %>
|
104
|
-
**Defined in:** <%= object.file ? object.file : "(unknown)" %>
|
104
|
+
**Defined in:** <%= object.file ? object.file.sub(Dir.pwd, "") : "(unknown)" %>
|
105
105
|
<% end %>
|
106
106
|
|
107
107
|
<%= rdoc_to_md object.docstring %>
|
@@ -138,12 +138,14 @@ def serialize(object)
|
|
138
138
|
## <%= cnst.name %> [](#<%=aref(cnst)%>)
|
139
139
|
<%= rdoc_to_md cnst.docstring %>
|
140
140
|
|
141
|
-
<% end %><% end %><% end %>',
|
141
|
+
<% end %><% end %><% end %>',
|
142
|
+
trim_mode: "<>",
|
143
|
+
)
|
142
144
|
|
143
145
|
template.result(binding)
|
144
146
|
end
|
145
147
|
|
146
|
-
require
|
148
|
+
require "rdoc"
|
147
149
|
|
148
150
|
def rdoc_to_md(docstring)
|
149
151
|
RDoc::Markup::ToMarkdown.new.convert(docstring)
|
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.
|
4
|
+
version: 0.3.5
|
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-
|
11
|
+
date: 2024-08-25 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: yard
|
@@ -24,7 +24,7 @@ dependencies:
|
|
24
24
|
- - ">="
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: '0'
|
27
|
-
description: yard plugin to
|
27
|
+
description: yard plugin to generate markdown documentation for gems
|
28
28
|
email:
|
29
29
|
- yard-markdown@skatkov.com
|
30
30
|
executables: []
|
@@ -41,6 +41,8 @@ files:
|
|
41
41
|
- example/Bird.md
|
42
42
|
- example/Duck.md
|
43
43
|
- example/Waterfowl.md
|
44
|
+
- example/YARD.md
|
45
|
+
- example/YARD/Markdown.md
|
44
46
|
- example/index.csv
|
45
47
|
- lib/yard-markdown.rb
|
46
48
|
- sig/yard/markdown.rbs
|
@@ -66,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
66
68
|
- !ruby/object:Gem::Version
|
67
69
|
version: '0'
|
68
70
|
requirements: []
|
69
|
-
rubygems_version: 3.5.
|
71
|
+
rubygems_version: 3.5.17
|
70
72
|
signing_key:
|
71
73
|
specification_version: 4
|
72
74
|
summary: yard plugin to generate markdown documentation
|