yard-markdown 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 336637063b30cdb36819afce2e0380f467c1763ebbb022b006317488edebe134
-  data.tar.gz: 73692c82e184b6e3b7259af0ba1ce74fea209b71a56ed089c611ac0035415bbd
+  metadata.gz: '0282033a919774b5cd92979a1291cda4ed834c27cbfc21ca231982475aefa6cf'
+  data.tar.gz: ade62aa4bc7c6091cbdc229bebf16ec77f753bba17e0ab0e0ef0fe28527838a9
 SHA512:
-  metadata.gz: e9b0c05b3cfef30f77040ea8542091dd99231cece58f912079c0e356042bfe99fbfd4aad80e509bdad0390f07cc23d0a4be133db8d4c67e33981556cea87bbfd
-  data.tar.gz: c32c66c335f301dcaec541401b7d1276267aa5054b29574f70d8d1697680dddae6d649b044ce934df88ee4372efbbe2cb45e9eb6570aea6b0a465f77c91e57a4
+  metadata.gz: 8604ca85cdc4e6486b00e94a694fa35661dc06c9042882e41afe9e41fa863d582173473b8fbc8e1edb8e08db8908ab26bc887c4773465c8d94c04c6c72992366
+  data.tar.gz: bbf3e68cd55b9ead82fbe0307d106e7e31a284fbb567eadb3bf6ab08c4b2ba1523699629950e7d85124216da3c94f114220e3bf2c0857d5f0d2d088ca39d0074

data/example/Bird.md

@@ -1,36 +1,53 @@
 # 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.
+
+
+  # Public Instance Methods
+  
+  ## _fly_impl(_direction, _velocity) [](#method-i-_fly_impl)
+  :nodoc:
+
+
+  
+  ## fly(direction, velocity) [](#method-i-fly)
+  Fly somewhere.
 
 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
+
+    fly(:south, 70)
+
+
+  
+  ## 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.
+
 
-= Example
+  
+  ## DEFAULT_SPEED [](#constant-DEFAULT_SPEED)
+  Maximum speed for a swimming duck.
 
-  fly(:south, 70)
-## speak() [](#method-i-speak)
-Produce some noise.
---
-FIXME: maybe extract this to a base class +Animal+?
-++
 
+  
+  

data/example/Duck.md

@@ -1,47 +1,82 @@
 # 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.
+
+  # 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)
+  
+
+  
+  # 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.
 
-# 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.
+  
+  

data/example/Waterfowl.md

@@ -1,16 +1,30 @@
 # Module: Waterfowl
-| | |
-| -----------------:  | :-----    |
-| **Defined in:**    | example.rb    |
+    
+**Defined in:** example.rb
 
 A mixin for waterfowl creatures.
-# 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.
 
+  # 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.
+
+
+  
+  

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

@@ -94,38 +94,24 @@ 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 %>
 
-<%= object.docstring %>
+<%= rdoc_to_md 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 %>
+  <%= rdoc_to_md item.docstring %>
 
   <% end %>
 <% end %>
@@ -134,7 +120,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 %>
@@ -142,17 +128,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 %>
+
+
+<% 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 %>
-  '.gsub(/^  /, ""),
-      trim_mode: "%<>",
-    )
+<% 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.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-11 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