yard-markdown 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45d1e77bad42779c78eb819361eeef638e1eb6a6b622ef7f850298258a4cbf14
-  data.tar.gz: 715a1015c9d12f9ccdd13e9afe20f70e3b566dc9996161b8cedfcc7eecbcc9bf
+  metadata.gz: f629ca40401c7ee044ca4f7c513ec1e008f84f0a9bb7052ad70f15480d573f3c
+  data.tar.gz: 4b599efff7a4c66581aae75cbb0516950c5d444a07d8f6f9ed588f2f5491498d
 SHA512:
-  metadata.gz: c813cfeaad842d55c9b4573fa91f025ac07d78b8bb512a45f32af671a25c213d34e4291c6346ab0e43e141fab89dd82ba5ca279760e17b4ac06a1f042c39fd26
-  data.tar.gz: 4080476f10d33d9d98c39ca2d04e4834c2a1ef8308451ad102022991286f88e4f42bba1fbdf5ddac53a1c16ad3cb40fa53eb656b72d59d5155a6e6ea589db4d6
+  metadata.gz: 8ef3690daab52e53c0d0c5b12487c5063bcf2b6c168b04814e2ac89fa9848aa85e42a623a83a06abcd94f4051227465362462ccd47bc70b82462f9d9dd6cf139
+  data.tar.gz: 9e100dc76d5991c9dd767c4a7a4d04836fb832f29d81269328bfc76cbb9bcc6ae43f16e1b2102e98bcf46a0806c473584b8f052ea92820500c25243976b41e08

data/example/Bird.md

@@ -4,18 +4,17 @@
 | **Inherits:** | Object  |
 | **Defined in:**    | example.rb    |
 
-
 The base class for all birds.
-
 # Constants
-## DEFAULT_DUCK_VELOCITY = [](#constant-DEFAULT_DUCK_VELOCITY)
-(70) Default velocity for a flying duck.
-
+## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
+Default velocity for a flying duck.
+## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
+Maximum speed for a swimming duck.
 
 # Public Instance Methods
-## _fly_impl(_direction , _velocity ) [](#method-i-_fly_impl)
+## _fly_impl(_direction, _velocity) [](#method-i-_fly_impl)
 :nodoc:
-## fly(direction , velocity ) [](#method-i-fly)
+## fly(direction, velocity) [](#method-i-fly)
 Fly somewhere.
 
 Flying is the most critical feature of birds.

data/example/Duck.md

@@ -6,7 +6,6 @@
 | **Includes:** | Waterfowl |
 | **Defined in:**    | example.rb    |
 
-
 A duck is a Waterfowl Bird.
 
 Features:
@@ -19,14 +18,14 @@ Features:
  waterfowl::
 
    * swim
-
 # Constants
-## DEFAULT_DUCK_VELOCITY = [](#constant-DEFAULT_DUCK_VELOCITY)
-(70) Default velocity for a flying duck.
-
+## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
+Default velocity for a flying duck.
+## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
+Maximum speed for a swimming duck.
 
 # Public Instance Methods
-## initialize(domestic , rubber ) [](#method-i-initialize)
+## initialize(domestic, rubber) [](#method-i-initialize)
 Creates a new duck.
 ## speak() [](#method-i-speak)
 Duck overrides generic implementation.

data/example/Waterfowl.md

@@ -3,13 +3,12 @@
 | -----------------:  | :-----    |
 | **Defined in:**    | example.rb    |
 
-
 A mixin for waterfowl creatures.
-
 # Constants
-## DEFAULT_DUCK_VELOCITY = [](#constant-DEFAULT_DUCK_VELOCITY)
-(70) Default velocity for a flying duck.
-
+## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
+Default velocity for a flying duck.
+## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
+Maximum speed for a swimming duck.
 
 # Public Instance Methods
 ## swim() [](#method-i-swim)

data/example/index.csv

@@ -1,14 +1,17 @@
 name,type,path
 Waterfowl,Module,Waterfowl.md
 DEFAULT_DUCK_VELOCITY,Constant,Waterfowl.md#constant-DEFAULT_DUCK_VELOCITY
+DEFAULT_SPEED,Constant,Waterfowl.md#constant-DEFAULT_SPEED
 swim,Method,Waterfowl.md#method-i-swim
 Bird,Class,Bird.md
 DEFAULT_DUCK_VELOCITY,Constant,Bird.md#constant-DEFAULT_DUCK_VELOCITY
+DEFAULT_SPEED,Constant,Bird.md#constant-DEFAULT_SPEED
 _fly_impl,Method,Bird.md#method-i-_fly_impl
 fly,Method,Bird.md#method-i-fly
 speak,Method,Bird.md#method-i-speak
 Duck,Class,Duck.md
 DEFAULT_DUCK_VELOCITY,Constant,Duck.md#constant-DEFAULT_DUCK_VELOCITY
+DEFAULT_SPEED,Constant,Duck.md#constant-DEFAULT_SPEED
 initialize,Method,Duck.md#method-i-initialize
 speak,Method,Duck.md#method-i-speak
 swim,Method,Duck.md#method-i-swim

data/example.rb

@@ -131,6 +131,8 @@ end
 
 # Default velocity for a flying duck.
 DEFAULT_DUCK_VELOCITY = 70
+DEFAULT_SPEED = 10 # Maximum speed for a swimming duck.
+
 
 # Default rubber duck.
 #

data/templates/default/fulldoc/markdown/setup.rb

@@ -108,26 +108,14 @@ def serialize(object)
   | **Defined in:**    | <%= object.file ? object.file : "(unknown)" %>    |
 <% end %>
 
+<%= rdoc_to_md object.docstring %>
 
-<%= object.docstring %>
-
-
-<% if constant_listing.size > 0 %>
-<% groups(constant_listing, "Constants") do |list, name| %>
-  # <%= name %>
-  <% list.each do |cnst| %>
-  ## <%= cnst.name %> = [](#<%=aref(cnst)%>)
-  <%= cnst.docstring %>
-  <% end %>
-<% end %>
-
-<% end %>
 
 <% if (insmeths = public_instance_methods(object)).size > 0 %>
   # Public Instance Methods
   <% insmeths.each do |item| %>
-  ## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join(" ") }.join(", ")%>) [](#<%=aref(item)%>)
-  <%= item.docstring %>
+  ## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join("") }.join(", ")%>) [](#<%=aref(item)%>)
+  <%= rdoc_to_md item.docstring %>
 
   <% end %>
 <% end %>
@@ -136,7 +124,7 @@ def serialize(object)
   # Public Class Methods
   <% pubmeths.each do |item| %>
   ## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join(" ") }.join(", ") %>) [](#<%=aref(item)%>)
-  <%= item.docstring %>
+  <%= rdoc_to_md item.docstring %>
 
   <% end %>
 <% end %>
@@ -144,17 +132,33 @@ def serialize(object)
   # Attributes
   <% attrs.each do |item|%>
   ## <%= item.name %><%= item.reader? ? "[RW]" : "[R]" %> [](#<%=aref(item)%>)
-  <%= item.docstring %>
+  <%= rdoc_to_md item.docstring %>
 
   <% end %>
 <% end %>
-  '.gsub(/^  /, ""),
-      trim_mode: "%<>",
-    )
+
+
+<% if constant_listing.size > 0 %>
+<% groups(constant_listing, "Constants") do |list, name| %>
+  # <%= name %>
+  <% list.each do |cnst| %>
+  ## <%= cnst.name %> [](#<%=aref(cnst)%>)
+  <%= rdoc_to_md cnst.docstring %>
+
+  <% end %>
+<% end %>
+<% end %>
+  ', trim_mode: "%<>")
 
   template.result(binding)
 end
 
+require 'rdoc'
+
+def rdoc_to_md(docstring)
+  RDoc::Markup::ToMarkdown.new.convert(docstring)
+end
+
 def aref(object)
   if object.type == :constant
     "constant-#{object.name(false)}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard