📝 Add mathjax template for YARD

[ci skip]

Author: mrkn

.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+--template mathjax
+--template-path yard/templates

yard/templates/mathjax/class/dot/setup.rb

@@ -0,0 +1,6 @@
+include T('default/module/dot')
+
+def init
+  super
+  sections.push :superklass
+end

yard/templates/mathjax/class/dot/superklass.erb

@@ -0,0 +1,3 @@
+<% if object.superclass.path != "Object" && object.superclass.path != "BasicObject" %>
+  <%= format_path object %> -> <%= format_path object.superclass %>;
+<% end %>

yard/templates/mathjax/class/html/constructor_details.erb

@@ -0,0 +1,8 @@
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  <% if @ctor.namespace != object %>
+    <p class="notice">This class inherits a constructor from <%= linkify @ctor, @ctor.namespace.path %></p>
+  <% else %>
+    <%= yieldall :object => @ctor, :index => 0 %>
+  <% end %>
+</div>

yard/templates/mathjax/class/html/setup.rb

@@ -0,0 +1 @@
+include T('default/module/html')

yard/templates/mathjax/class/html/subclasses.erb

@@ -0,0 +1,4 @@
+<div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><%= @subclasses.map {|name, child| linkify(child, name) }.join(", ") %></p>
+</div>

yard/templates/mathjax/class/setup.rb

@@ -0,0 +1,36 @@
+include T('default/module')
+
+def init
+  super
+  sections.place(:subclasses).before(:children)
+  sections.place(:constructor_details, [T('method_details')]).before(:methodmissing)
+end
+
+def constructor_details
+  ctors = object.meths(:inherited => true, :included => true)
+  return unless @ctor = ctors.find {|o| o.constructor? }
+  return if prune_method_listing([@ctor]).empty?
+  erb(:constructor_details)
+end
+
+def subclasses
+  return if object.path == "Object" # don't show subclasses for Object
+  unless globals.subclasses
+    globals.subclasses = {}
+    list = run_verifier Registry.all(:class)
+    list.each do |o|
+      (globals.subclasses[o.superclass.path] ||= []) << o if o.superclass
+    end
+  end
+
+  @subclasses = globals.subclasses[object.path]
+  return if @subclasses.nil? || @subclasses.empty?
+  @subclasses = @subclasses.sort_by {|o| o.path }.map do |child|
+    name = child.path
+    if object.namespace
+      name = object.relative_path(child)
+    end
+    [name, child]
+  end
+  erb(:subclasses)
+end

yard/templates/mathjax/class/text/setup.rb

@@ -0,0 +1,11 @@
+include T('default/module/text')
+
+def init
+  super
+  sections.place(:subclasses).before(:children)
+  sections.delete(:children)
+end
+
+def format_object_title(object)
+  "Class: #{object.title} < #{object.superclass.title}"
+end

yard/templates/mathjax/class/text/subclasses.erb

@@ -0,0 +1,5 @@
+Direct Known Subclasses:
+------------------------
+
+<%= indent(wrap(@subclasses.map {|name, child| name }.join(", "))) %>
+

yard/templates/mathjax/constant/text/header.erb

@@ -0,0 +1,11 @@
+<%= title_align_right format_object_title(object) %>
+
+
+<%= object.name %> = <%= object.value.size > 40 ? "\n\n" + indent(object.value) : object.value %>
+
+
+<%= hr %>
+
+<%= yieldall %>
+
+<%= hr %>