yard-markdown 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0282033a919774b5cd92979a1291cda4ed834c27cbfc21ca231982475aefa6cf'
-  data.tar.gz: ade62aa4bc7c6091cbdc229bebf16ec77f753bba17e0ab0e0ef0fe28527838a9
+  metadata.gz: 994fce8f139b82058ade4ab60aeca1be434534bd49f0977bcdf95a651f47a58a
+  data.tar.gz: 144b2c3130b9a44d9329c752a61afedc6ca41a28b02a168c8ab6c896179e4857
 SHA512:
-  metadata.gz: 8604ca85cdc4e6486b00e94a694fa35661dc06c9042882e41afe9e41fa863d582173473b8fbc8e1edb8e08db8908ab26bc887c4773465c8d94c04c6c72992366
-  data.tar.gz: bbf3e68cd55b9ead82fbe0307d106e7e31a284fbb567eadb3bf6ab08c4b2ba1523699629950e7d85124216da3c94f114220e3bf2c0857d5f0d2d088ca39d0074
+  metadata.gz: 26ac0898777ff288b0af6860fb0aa92d824720e92ed53e008ce51584ac954751917f3f3e05d2ad46e79d2f4015abaad61ab79c488b63cbad388b8e6a91cce40d
+  data.tar.gz: 9a00633d63955616a565666aedac85b7c0d94841cc9c85bd0e810e79f7cbfd830c70163435c45d77f97aa77c27a4124460fc06f0a9cb20946055ed6af9994f36

data/example/Bird.md

@@ -5,16 +5,12 @@
 
 The base class for all birds.
 
+# Public Instance Methods
+## _fly_impl(_direction, _velocity) [](#method-i-_fly_impl)
+:nodoc:
 
-  # Public Instance Methods
-  
-  ## _fly_impl(_direction, _velocity) [](#method-i-_fly_impl)
-  :nodoc:
-
-
-  
-  ## fly(direction, velocity) [](#method-i-fly)
-  Fly somewhere.
+## fly(direction, velocity) [](#method-i-fly)
+Fly somewhere.
 
 Flying is the most critical feature of birds.
 
@@ -28,26 +24,15 @@ Flying is the most critical feature of birds.
 
     fly(:south, 70)
 
+## speak() [](#method-i-speak)
+Produce some noise. -- FIXME: maybe extract this to a base class `Animal`? ++
 
-  
-  ## speak() [](#method-i-speak)
-  Produce some noise. -- FIXME: maybe extract this to a base class `Animal`? ++
-
-
-  
-
-
-
-  # Constants
-  
-  ## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
-  Default velocity for a flying duck.
 
 
-  
-  ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
-  Maximum speed for a swimming duck.
+# Constants
+## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
+Default velocity for a flying duck.
 
+## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
+Maximum speed for a swimming duck.
 
-  
-  

data/example/Duck.md

@@ -20,63 +20,38 @@ Features:
 
       * swim
 
+# Public Instance Methods
+## initialize(domestic, rubber) [](#method-i-initialize)
+Creates a new duck.
 
-  # Public Instance Methods
-  
-  ## initialize(domestic, rubber) [](#method-i-initialize)
-  Creates a new duck.
-
-
-  
-  ## speak() [](#method-i-speak)
-  Duck overrides generic implementation.
-
-
-  
-  ## swim() [](#method-i-swim)
-  Swimming helper.
+## speak() [](#method-i-speak)
+Duck overrides generic implementation.
 
+## swim() [](#method-i-swim)
+Swimming helper.
 
-  
-  ## useful?() [](#method-i-useful?)
-  Checks if this duck is a useful one.
+## useful?() [](#method-i-useful?)
+Checks if this duck is a useful one.
 
 :call-seq:
     Bird.useful? -> bool
 
 
-  
-
-  # Public Class Methods
-  
-  ## rubber_ducks() [](#method-c-rubber_ducks)
-  
-
-  
-  # Attributes
-  
-  ## domestic[RW] [](#attribute-i-domestic)
-  True for domestic ducks.
-
-
-  
-  ## rubber[RW] [](#attribute-i-rubber)
-  True for rubber ducks.
-
-
-  
+# Public Class Methods
+## rubber_ducks() [](#method-c-rubber_ducks)
 
+# Attributes
+## domestic[RW] [](#attribute-i-domestic)
+True for domestic ducks.
 
-  # Constants
-  
-  ## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
-  Default velocity for a flying duck.
+## rubber[RW] [](#attribute-i-rubber)
+True for rubber ducks.
 
 
-  
-  ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
-  Maximum speed for a swimming duck.
+# Constants
+## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
+Default velocity for a flying duck.
 
+## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
+Maximum speed for a swimming duck.
 
-  
-  

data/example/Waterfowl.md

@@ -4,27 +4,16 @@
 
 A mixin for waterfowl creatures.
 
+# Public Instance Methods
+## swim() [](#method-i-swim)
+Swimming helper.
 
-  # Public Instance Methods
-  
-  ## swim() [](#method-i-swim)
-  Swimming helper.
 
 
-  
+# Constants
+## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
+Default velocity for a flying duck.
 
+## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
+Maximum speed for a swimming duck.
 
-
-  # Constants
-  
-  ## DEFAULT_DUCK_VELOCITY [](#constant-DEFAULT_DUCK_VELOCITY)
-  Default velocity for a flying duck.
-
-
-  
-  ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
-  Maximum speed for a swimming duck.
-
-
-  
-  

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

@@ -42,9 +42,9 @@ def serialize_index(objects)
       next if object.name == :root
 
       if object.type == :class
-        csv << [object.name, "Class", options.serializer.serialized_path(object)]
+        csv << [object.path, "Class", options.serializer.serialized_path(object)]
       elsif object.type == :module
-        csv << [object.name, "Module", options.serializer.serialized_path(object)]
+        csv << [object.path, "Module", options.serializer.serialized_path(object)]
       end
 
       if constant_listing.size.positive?
@@ -106,45 +106,39 @@ def serialize(object)
 
 <%= rdoc_to_md object.docstring %>
 
-
 <% 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)%>)
-  <%= rdoc_to_md item.docstring %>
+# Public Instance Methods
+<% insmeths.each do |item| %>
+## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join("") }.join(", ")%>) [](#<%=aref(item)%>)
+<%= rdoc_to_md item.docstring %>
 
-  <% end %>
-<% end %>
+<% end %><% end %>
 
 <% if (pubmeths = public_class_methods(object)).size > 0 %>
-  # Public Class Methods
-  <% pubmeths.each do |item| %>
-  ## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join(" ") }.join(", ") %>) [](#<%=aref(item)%>)
-  <%= rdoc_to_md item.docstring %>
+# Public Class Methods
+<% pubmeths.each do |item| %>
+## <%= item.name(false) %>(<%= item.parameters.map {|p| p.join(" ") }.join(", ") %>) [](#<%=aref(item)%>)
+<%= rdoc_to_md item.docstring %>
 
-  <% end %>
+<% end %>
 <% end %>
 <% if (attrs = attr_listing(object)).size > 0 %>
-  # Attributes
-  <% attrs.each do |item|%>
-  ## <%= item.name %><%= item.reader? ? "[RW]" : "[R]" %> [](#<%=aref(item)%>)
-  <%= rdoc_to_md item.docstring %>
+# Attributes
+<% attrs.each do |item|%>
+## <%= item.name %><%= item.reader? ? "[RW]" : "[R]" %> [](#<%=aref(item)%>)
+<%= rdoc_to_md item.docstring %>
 
-  <% end %>
 <% end %>
-
+<% end %>
 
 <% 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 %>
+# <%= name %>
+<% list.each do |cnst| %>
+## <%= cnst.name %> [](#<%=aref(cnst)%>)
+<%= rdoc_to_md cnst.docstring %>
 
-  <% end %>
-<% end %>
-<% end %>
-  ', trim_mode: "%<>")
+<% end %><% end %><% end %>', trim_mode: "<>")
 
   template.result(binding)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: yard plugin to generate markdown documentation