yard-markdown 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f629ca40401c7ee044ca4f7c513ec1e008f84f0a9bb7052ad70f15480d573f3c
-  data.tar.gz: 4b599efff7a4c66581aae75cbb0516950c5d444a07d8f6f9ed588f2f5491498d
+  metadata.gz: c6a31bd0b9314cb81e288f61c6f923ad3b8b5708ae1776ca0728fc9e0e8b3a07
+  data.tar.gz: 83f19bcda05228295f943c1cb09cde16dc6738c60e96a7194eade9f15597c17e
 SHA512:
-  metadata.gz: 8ef3690daab52e53c0d0c5b12487c5063bcf2b6c168b04814e2ac89fa9848aa85e42a623a83a06abcd94f4051227465362462ccd47bc70b82462f9d9dd6cf139
-  data.tar.gz: 9e100dc76d5991c9dd767c4a7a4d04836fb832f29d81269328bfc76cbb9bcc6ae43f16e1b2102e98bcf46a0806c473584b8f052ea92820500c25243976b41e08
+  metadata.gz: 3e4d2ecd151a91ba5085d86f398f592c71d2d0744f46487bb07969190f8070acdeb15841325dff7a8c1b96e651fbf375a4cb3c358b5032b1734cbcc8b988c7e8
+  data.tar.gz: 1713b22f373b5fc163202d2e51b9c6ff3fe4f502facba94eaa37e77874ae2222f6e3e9dd5f16e6630210870528fc68cfbd86956d2bb8da6bd8b16cb4efef3724

data/example/Bird.md

@@ -1,19 +1,14 @@
 # Class: Bird
-| | |
-| -----------------:  | :-----    |
-| **Inherits:** | Object  |
-| **Defined in:**    | example.rb    |
+**Inherits:** Object
+    
+**Defined in:** example.rb
 
 The base class for all birds.
-# 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.
 
 # Public Instance Methods
 ## _fly_impl(_direction, _velocity) [](#method-i-_fly_impl)
 :nodoc:
+
 ## fly(direction, velocity) [](#method-i-fly)
 Fly somewhere.
 
@@ -22,15 +17,22 @@ Flying is the most critical feature of birds.
 :args: direction, velocity
 
 :call-seq:
-  Bird.fly(symbol, number) -> bool
-  Bird.fly(string, number) -> bool
+    Bird.fly(symbol, number) -> bool
+    Bird.fly(string, number) -> bool
 
-= Example
+# Example
+
+    fly(:south, 70)
 
-  fly(:south, 70)
 ## speak() [](#method-i-speak)
-Produce some noise.
---
-FIXME: maybe extract this to a base class +Animal+?
-++
+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.
 

data/example/Duck.md

@@ -1,41 +1,41 @@
 # Class: Duck
-| | |
-| -----------------:  | :-----    |
-| **Inherits:** | Object  |
-| **Extended by:** | Animal |
-| **Includes:** | Waterfowl |
-| **Defined in:**    | example.rb    |
+**Inherits:** Object
+  
+**Extended by:** Animal
+    
+**Includes:** Waterfowl
+  
+**Defined in:** example.rb
 
 A duck is a Waterfowl Bird.
 
 Features:
 
- bird::
+    bird::
 
-   * speak
-   * fly
+      * speak
+      * fly
 
- waterfowl::
+    waterfowl::
 
-   * swim
-# 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.
+      * swim
 
 # 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.
+
 ## useful?() [](#method-i-useful?)
 Checks if this duck is a useful one.
 
 :call-seq:
-  Bird.useful? -> bool
+    Bird.useful? -> bool
+
 
 # Public Class Methods
 ## rubber_ducks() [](#method-c-rubber_ducks)
@@ -43,5 +43,15 @@ Checks if this duck is a useful one.
 # Attributes
 ## domestic[RW] [](#attribute-i-domestic)
 True for domestic ducks.
+
 ## rubber[RW] [](#attribute-i-rubber)
 True for rubber ducks.
+
+
+# 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

@@ -1,16 +1,19 @@
 # Module: Waterfowl
-| | |
-| -----------------:  | :-----    |
-| **Defined in:**    | example.rb    |
+    
+**Defined in:** example.rb
 
 A mixin for waterfowl creatures.
+
+# 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.
 
-# Public Instance Methods
-## swim() [](#method-i-swim)
-Swimming helper.
-

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

@@ -94,61 +94,51 @@ def serialize(object)
   template =
     ERB.new(
       '# <%= format_object_title object %>
-| | |
-| -----------------:  | :-----    |
 <% if CodeObjects::ClassObject === object && object.superclass %>
-  | **Inherits:** | <%= object.superclass %>  |
-<% end %>
-<% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
+**Inherits:** <%= object.superclass %>
+<% end %><% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
   <% if (mix = run_verifier(object.mixins(scope))).size > 0 %>
-  | **<%= name %>:** | <%= mix.sort_by {|o| o.path }.join(", ") %> |
-  <% end %>
-<% end %>
+**<%= name %>:** <%= mix.sort_by {|o| o.path }.join(", ") %>
+  <% end %><% end %>
 <% unless object.root? %>
-  | **Defined in:**    | <%= object.file ? object.file : "(unknown)" %>    |
+**Defined in:** <%= object.file ? object.file : "(unknown)" %>
 <% end %>
 
 <%= 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.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-01-29 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.4
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: yard plugin to generate markdown documentation