rorvswild_theme_rdoc 0.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 644ca7e98768cde147466db475445d638a9088763544bf6079b07a733a81c2cb
-  data.tar.gz: 25bd0e85b44696929dff36c111b7b7ad4357d08c635c2be985acaa23eae8869d
+  metadata.gz: a85143e9f438f5dd7bd333dbe53fcde2cc560e7436eb3b316255ffaf37a22d28
+  data.tar.gz: 448575df025e5b14f3b346383106d4e2b84deae015c1d9d9ff8cc927f10c59bd
 SHA512:
-  metadata.gz: 8408dd7c64c3992f73ed7b7d652bd290ed13d1daa542559b3a39318511819cb16d3f79937a935f6cacadb4fc3fd1e6eea57861e839d81e55e0d1b740bb37d681
-  data.tar.gz: f370ed02cbd1b9cdc9cdc8d56995623660c90981b8cdd659a899d4ea35404de19c8768bcf334395b5f79cee741afcfdeba2ff44abdc317c4136e0064ff2c8cd1
+  metadata.gz: eb458897afe53c38740177ea535cf795a4a3b164163efd920932a4d44f09d36050dc5f6f625069dce6ade54817446110d5068247fa24b35946a4055738e61079
+  data.tar.gz: bdad2622cdbf75bb81ebba5e17c96102535ad62a098838e159fc437a89b967677d4b04004307360444b0fdf2a148639d4c6964f1e864420312418a3396e3100c

data/LICENSE

@@ -0,0 +1,29 @@
+RorVsWild RDoc theme is based on Darkfish, of which this is the original license:
+
+
+Copyright (c) 2007, 2008, Michael Granger. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,27 @@
+# RoRvsWild theme for RDoc
+
+[RDoc](https://github.com/ruby/rdoc) theme based on [RoRvsWild](https://www.rorvswild.com/) colors.
+More than colors, it modifies the layout, navigation, typography and overall look and feel.
+
+![RoRvsWild theme RDoc Light](https://cdn.rorvswild.com/assets/blog/2024/rdoc_new-ad5d5ed01e18b11607278cdf97899209dfac8a752b2f0413e83b859b90f48009.png)
+
+![RoRvsWild theme RDoc Dark](https://cdn.rorvswild.com/assets/blog/2024/rdoc_new_dark-06b332002ea3c7df9aafd2a5081fd901d0ca02450b4a002fda08acb4395b29e6.png)
+
+## Usage
+
+If you want to use this theme in your documentation:
+```
+# Install the gem
+gem install rorvswild_theme_rdoc
+
+# Generate the documentation
+rdoc --root path/to/source/code --template rorvswild
+```
+
+## Development
+
+Call the custom `rorvswild-theme-rdoc` script which automatically loads RoRvsWild's theme.
+
+```
+./rorvswild-theme-rdoc --root path/to/source/code
+```

data/lib/rdoc/discover.rb

@@ -0,0 +1 @@
+require "rorvswild_theme_rdoc"

data/lib/rdoc/generator/template/rorvswild/_dialog_search.rhtml

@@ -0,0 +1,16 @@
+<dialog id="search-dialog" role="search" class="search-dialog initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"><circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line></svg>
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden">
+    </ul>
+  </form>
+</dialog>

data/lib/rdoc/generator/template/rorvswild/_footer.rhtml

@@ -0,0 +1,4 @@
+<footer role="contentinfo">
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> <%= RDoc::VERSION %>. <a href="https://validator.w3.org/check/referer">Validate</a>
+  <p><a href="http://rorvswild.com/theme">RoRvsWild theme</a> based on <a href="http://deveiate.org">Darkfish</a>.
+</footer>

data/lib/rdoc/generator/template/rorvswild/_head.rhtml

@@ -0,0 +1,25 @@
+<meta charset="<%= @options.charset %>">
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+
+<title><%= h @title %></title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "<%= h asset_rel_prefix %>/";
+  var index_rel_prefix = "<%= h rel_prefix %>/";
+</script>
+
+<script src="<%= h asset_rel_prefix %>/js/navigation.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/search.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/search_index.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/searcher.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/darkfish.js" defer></script>
+
+<link rel="preconnect" href="https://fonts.googleapis.com">
+<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+<link href="https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap" rel="stylesheet">
+
+<link href="<%= h asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
+<link href="<%= h asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
+<%- @options.template_stylesheets.each do |stylesheet| -%>
+<link href="<%= h asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
+<%- end -%>

data/lib/rdoc/generator/template/rorvswild/_navigation.rhtml

@@ -0,0 +1,5 @@
+<nav id="navigation" role="navigation">
+  <%= render '_sidebar_classes.rhtml' %>
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_footer.rhtml' %>
+</nav>

data/lib/rdoc/generator/template/rorvswild/_sidebar_VCS_info.rhtml

@@ -0,0 +1,19 @@
+<%- if !svninfo.empty? then %>
+<div id="file-svninfo-section" class="nav-section">
+  <h3>VCS Info</h3>
+
+  <div class="section-body">
+    <dl class="svninfo">
+      <dt>Rev
+      <dd><%= svninfo[:rev] %>
+
+      <dt>Last Checked In
+      <dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
+        (<%= svninfo[:commitdelta] %> ago)
+
+      <dt>Checked in by
+      <dd><%= svninfo[:committer] %>
+    </dl>
+  </div>
+</div>
+<%- end -%>

data/lib/rdoc/generator/template/rorvswild/_sidebar_classes.rhtml

@@ -0,0 +1,48 @@
+<div class="nav-section">
+  <h3>Class and Module Index</h3>
+
+  <%-
+  all_classes = @classes.group_by do |klass|
+    klass.full_name[/\A[^:]++(?:::[^:]++(?=::))*+(?=::[^:]*+\z)/]
+  end.delete_if do |_, klasses|
+    !klasses.any?(&:display?)
+  end
+  link = proc do |index_klass, display = index_klass.display?|
+    if display
+      -%><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.name %></a><%-
+    else
+      -%><%= index_klass.name %><%-
+    end
+  end
+
+  def has_active_descendant?(klass, current, all_classes)
+    return false unless defined?(current)
+    return true if klass == current
+    children = all_classes[klass.full_name]
+    return false unless children
+    children.any? { |child| has_active_descendant?(child, current, all_classes) }
+  end
+
+  if top = all_classes[nil]
+    solo = top.one? {|klass| klass.display?}
+    traverse = proc do |klasses|
+      has_active_descendant = false
+      -%>
+    <ul class="link-list" id="class-and-module-index">
+      <%- klasses.each do |index_klass| -%>
+        <%- if children = all_classes[index_klass.full_name] -%>
+          <li class="<%= "active" if defined?(current) && (index_klass == current) %>">
+            <details<% if solo || (defined?(current) && has_active_descendant?(index_klass, current, all_classes)); solo = false %>  open<% end %>>
+              <summary><% link.call(index_klass) %></summary>
+              <%- traverse.call(children) -%>
+              </ul>
+            </details>
+        <%- elsif index_klass.display? -%>
+          <li class="<%= "active" if defined?(current) && (index_klass == current) %>">
+            <% link.call(index_klass, true) %>
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+    <%- traverse.call(top) -%>
+  <%- end -%>
+</div>

data/lib/rdoc/generator/template/rorvswild/_sidebar_constants.rhtml

@@ -0,0 +1,10 @@
+<% if (constants = klass.constants.sort).any? %>
+  <div class="nav-section">
+    <h3>Constants</h3>
+    <ul class="link-list" role="directory">
+      <%- constants.each do |const| -%>
+      <li><a href="#<%= h const.name %>"><%= h const.name -%></a></li>
+      <%- end -%>
+    </ul>
+  </div>
+<% end %>

data/lib/rdoc/generator/template/rorvswild/_sidebar_extends.rhtml

@@ -0,0 +1,15 @@
+<%- unless klass.extends.empty? then %>
+  <div class="nav-section">
+    <h3>Extended With Modules</h3>
+
+    <ul class="link-list">
+      <%- klass.extends.each do |ext| -%>
+    <%- unless String === ext.module then -%>
+      <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
+    <%- else -%>
+      <li><span class="extend"><%= ext.name %></span>
+    <%- end -%>
+    <%- end -%>
+    </ul>
+  </div>
+<%- end -%>

data/lib/rdoc/generator/template/rorvswild/_sidebar_in_files.rhtml

@@ -0,0 +1,8 @@
+<div id="file-list-section" class="nav-section">
+  <h3>Defined In</h3>
+  <ul>
+    <%- klass.in_files.each do |tl| -%>
+      <li><%= h tl.relative_name %>
+    <%- end -%>
+  </ul>
+</div>

data/lib/rdoc/generator/template/rorvswild/_sidebar_includes.rhtml

@@ -0,0 +1,15 @@
+<%- unless klass.includes.empty? then %>
+  <div class="nav-section">
+    <h3>Included Modules</h3>
+
+    <ul class="link-list">
+    <%- klass.includes.each do |inc| -%>
+    <%- unless String === inc.module then -%>
+      <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
+    <%- else -%>
+      <li><span class="include"><%= inc.name %></span>
+    <%- end -%>
+    <%- end -%>
+    </ul>
+  </div>
+<%- end -%>

data/lib/rdoc/generator/template/rorvswild/_sidebar_installed.rhtml

@@ -0,0 +1,15 @@
+<div id="home-section" class="nav-section">
+  <h3>Documentation</h3>
+
+  <ul>
+  <%- installed.each do |name, href, exists, type, _| -%>
+    <%- next if type == :extra -%>
+    <li class="folder">
+    <%- if exists then -%>
+      <a href="<%= href %>"><%= h name %></a>
+    <%- else -%>
+      <%= h name %>
+    <%- end -%>
+  <%- end -%>
+  </ul>
+</div>

data/lib/rdoc/generator/template/rorvswild/_sidebar_methods.rhtml

@@ -0,0 +1,21 @@
+<% if (class_methods = klass.class_method_list.sort).any? %>
+  <div class="nav-section">
+    <h3>Class Methods</h3>
+    <ul class="link-list" role="directory">
+      <%- class_methods.each do |meth| -%>
+      <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name -%></a></li>
+      <%- end -%>
+    </ul>
+  </div>
+<% end %>
+
+<% if (instance_methods = klass.instance_methods.sort).any? %>
+  <div class="nav-section">
+    <h3>Instance Methods</h3>
+    <ul class="link-list" role="directory">
+      <%- instance_methods.each do |meth| -%>
+      <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name -%></a></li>
+      <%- end -%>
+    </ul>
+  </div>
+<% end %>

data/lib/rdoc/generator/template/rorvswild/_sidebar_pages.rhtml

@@ -0,0 +1,34 @@
+<%- simple_files = @files.select { |f| f.text? } %>
+
+<%- if defined?(current) && current.respond_to?(:page_name) -%>
+  <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name -%>
+<%- end -%>
+
+<%- unless simple_files.empty? then -%>
+<div class="nav-section">
+  <h3>Pages</h3>
+
+  <ul class="link-list">
+  <%- simple_files.group_by do |f| -%>
+    <%- f.full_name[%r{\A[^/]+(?=/)}] || f.page_name -%>
+  <%- end.each do |n, files| -%>
+    <%- f = files.shift -%>
+    <%- if files.empty? -%>
+      <li class="<%= 'active' if defined?(dir) && (dir == f.page_name) %>"><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
+      <%- next -%>
+    <%- end -%>
+    <li><details<% if dir == n %> open<% end %>><summary><%
+    if n == f.page_name
+      %><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h n %></a><%
+    else
+      %><%= h n %><% files.unshift(f)
+    end %></summary>
+    <ul class="link-list">
+    <%- files.each do |f| -%>
+      <li class="<%= 'active' if defined?(dir) && (dir == f.page_name) %>"><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
+    <%- end -%>
+    </ul></details>
+  <%- end -%>
+  </ul>
+</div>
+<%- end -%>

data/lib/rdoc/generator/template/rorvswild/_sidebar_parent.rhtml

@@ -0,0 +1,41 @@
+<%- if klass.type == 'class' && (ancestors = klass.super_classes).any? then -%>
+  <div class="nav-section">
+    <h3>Ancestors</h3>
+    <ul class="link-list" role="directory">
+      <%- ancestors.each_with_index do |ancestor, index| -%>
+        <%- if ancestor.is_a?(String) -%>
+          <li>
+            <%- if index == 0 && ancestors.size > 1 -%>
+              <details>
+                <summary><%= ancestor -%></summary>
+                  <ul class="link-list" role="directory">
+            <%- else -%>
+              <span><%= ancestor -%></span>
+              <ul class="link-list" role="directory">
+            <%- end -%>
+        <%- elsif ancestor.is_a?(RDoc::NormalClass) -%>
+          <li>
+            <%- if index == 0 && ancestors.size > 1 -%>
+              <details>
+                <summary><a href="<%= klass.aref_to ancestor.path -%>"><%= ancestor.full_name -%></a></summary>
+                <ul class="link-list" role="directory">
+            <%- else -%>
+              <a href="<%= klass.aref_to ancestor.path -%>"><%= ancestor.full_name -%></a>
+              <ul class="link-list" role="directory">
+            <%- end -%>
+        <%- end -%>
+      <%- end -%>
+
+      <%- ancestors.each_with_index do |ancestor, index| -%>
+        <%- if index == 0 && ancestors.size > 1 -%>
+              </ul>
+            </details>
+          </li>
+        <%- else -%>
+            </ul>
+          </li>
+        <%- end -%>
+      <%- end -%>
+    </ul>
+  </div>
+<%- end -%>

data/lib/rdoc/generator/template/rorvswild/_sidebar_sections.rhtml

@@ -0,0 +1,11 @@
+<%- unless klass.sections.length == 1 then %>
+  <div class="nav-section">
+    <h3>Sections</h3>
+
+    <ul class="link-list" role="directory">
+      <%- klass.sort_sections.each do |section| -%>
+        <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
+      <%- end -%>
+    </ul>
+  </div>
+<%- end -%>

data/lib/rdoc/generator/template/rorvswild/_sidebar_table_of_contents.rhtml

@@ -0,0 +1,40 @@
+<%-   
+  comment = if current.respond_to? :comment_location then
+               current.comment_location
+             else
+               current.comment
+             end
+   table = current.parse(comment).table_of_contents.dup
+
+   if table.length > 1 then %>
+  <div class="nav-section">
+    <h3>On this page</h3>
+
+    <%- display_link = proc do |heading| -%>
+      <a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
+    <%- end -%>
+
+    <%- list_siblings = proc do -%>
+      <%- level = table.first&.level -%>
+      <%- while table.first && table.first.level >= level -%>
+        <%- heading = table.shift -%>
+        <%- if table.first.nil? || table.first.level <= heading.level -%>
+          <li><% display_link.call heading -%>
+        <%- else -%>
+          <li>
+            <details open>
+              <summary><%- display_link.call heading -%></summary>
+              <ul class="link-list" role="directory">
+                <% list_siblings.call %>
+              </ul>
+            </details>
+          </li>
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+    
+    <ul class="link-list" role="directory">
+      <% list_siblings.call %>
+    </ul>
+  </div>
+<%- end -%>

data/lib/rdoc/generator/template/rorvswild/_sidebar_toggle.rhtml

@@ -0,0 +1,3 @@
+<div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
+  <span aria-hidden="true">&#9776;</span>
+</div>

data/lib/rdoc/generator/template/rorvswild/_topbar.rhtml

@@ -0,0 +1,12 @@
+<header class="topbar">
+  <div class="width-limiter">
+    <%= render '_sidebar_toggle.rhtml' %>
+    <a href="<%= rel_prefix %>/index.html" rel="home"><%= @options.title %></a>
+    <button type="button" aria-label="Search" class="search-button">
+      <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"><circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line></svg>
+      <span>search</span>
+    </button>
+  </div>
+</header>
+
+<%= render '_dialog_search.rhtml' %>

data/lib/rdoc/generator/template/rorvswild/class.rhtml

@@ -0,0 +1,187 @@
+<body id="top" role="document">
+  <%= render '_topbar.rhtml' %>
+  <div class="wrapper">
+    <%= render '_navigation.rhtml' %>
+
+    <main role="main" aria-labelledby="<%=h klass.aref %>">
+      <article>
+        <h1 id="<%=h klass.aref %>">
+          <%= klass.type %> <%= klass.full_name %>
+        </h1>
+
+        <%= klass.description %>
+
+        <%- klass.each_section do |section, constants, attributes| -%>
+          
+            <%- if section.title then -%>
+              <h2><%= section.title %></h2>
+            <%- end -%>
+
+            <%- if section.comment then -%>
+              <div><%= section.description %></div>
+            <%- end -%>
+
+            <%- unless constants.empty? then -%>
+              <section class="constants-list">
+                <header>
+                  <h2>Constants</h2>
+                </header>
+                <dl>
+                  <%- constants.each do |const| -%>
+                    <dt id="<%= const.name %>"><%= const.name %></dt>
+                    <%- if const.comment then -%>
+                      <dd>
+                        <!-- commented future feature
+                        <%#- if const.mixin_from then -%>
+                          <div class="mixin-from">
+                            Included from <a href="<%#= klass.aref_to(const.mixin_from.path)%>"><%#= const.mixin_from.full_name %></a>
+                          </div>
+                        <%#- end -%>
+                        -->
+                        <%= const.description.strip %>
+                      </dd>
+                    <%- else -%>
+                      <dd class="missing-docs">(Not documented)</dd>
+                    <%- end -%>
+                  <%- end -%>
+                </dl>
+              </section>
+            <%- end -%>
+
+            <%- unless attributes.empty? then -%>
+              <section class="attribute-method-details" class="method-section">
+                <header>
+                  <h2>Attributes</h2>
+                </header>
+                <%- attributes.each do |attrib| -%>
+                  <div id="<%= attrib.aref %>" class="method-detail">
+                    <div class="method-heading attribute-method-heading">
+                      <a href="#<%= attrib.aref %>" title="Link to this attribute">
+                        <span class="method-name"><%= h attrib.name %></span>
+                        <span class="attribute-access-type">[<%= attrib.rw %>]</span>
+                      </a>
+                    </div>
+
+                    <div class="method-description">
+                      <!-- commented future feature
+                      <%#- if attrib.mixin_from then -%>
+                        <div class="mixin-from">
+                          <%#= attrib.singleton ? "Extended" : "Included" %> from <a href="<%#= klass.aref_to(attrib.mixin_from.path)%>"><%#= attrib.mixin_from.full_name %></a>
+                        </div>
+                      <%#- end -%>
+                      -->
+                      <%- if attrib.comment then -%>
+                        <%= attrib.description.strip %>
+                      <%- else -%>
+                        <p class="missing-docs">(Not documented)</p>
+                      <%- end -%>
+                    </div>
+                  </div>
+                <%- end -%>
+              </section>
+            <%- end -%>
+
+            <%- klass.methods_by_type(section).each do |type, visibilities|
+              next if visibilities.empty?
+              visibilities.each do |visibility, methods|
+                next if methods.empty? %>
+              <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section">
+                <header>
+                  <h2><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h2>
+                </header>
+
+                <%- methods.each do |method| -%>
+                  <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
+                    <div class="method-header">
+                      <%- if (call_seq = method.call_seq) then -%>
+                        <%- call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
+                          <div class="method-heading">
+                            <a href="#<%= method.aref %>" title="Link to this method">
+                              <span class="method-callseq">
+                                <%= h(call_seq.strip.
+                                    gsub( /^\w+\./m, '')).
+                                    gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
+                              </span>
+                            </a>
+                          </div>
+                        <%- end -%>
+                      <%- elsif method.has_call_seq? then -%>
+                        <div class="method-heading">
+                          <a href="#<%= method.aref %>" title="Link to this method">
+                            <span class="method-name"><%= h method.name %></span>
+                          </a>
+                        </div>
+                      <%- else -%>
+                        <div class="method-heading">
+                          <a href="#<%= method.aref %>" title="Link to this method">
+                            <span class="method-name"><%= h method.name %></span>
+                            <span class="method-args"><%= h method.param_seq %></span>
+                          </a>
+                        </div>
+                      <%- end -%>
+                    </div>
+
+                    <%- unless method.skip_description? then -%>
+                      <div class="method-description">
+                        <!-- commented future feature
+                        <%#- if method.mixin_from then -%>
+                          <div class="mixin-from">
+                            <%#= method.singleton ? "Extended" : "Included" %> from <a href="<%#= klass.aref_to(method.mixin_from.path)%>"><%#= method.mixin_from.full_name %></a>
+                          </div>
+                        <%#- end -%>
+                        -->
+                        <%- if method.comment then -%>
+                          <%= method.description.strip %>
+                        <%- else -%>
+                          <p class="missing-docs">(Not documented)</p>
+                        <%- end -%>
+                        <%- if method.calls_super then -%>
+                          <div class="method-calls-super">
+                            Calls superclass method <%= method.superclass_method ? method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil %>
+                          </div>
+                        <%- end -%> 
+                        <%- if method.token_stream then -%>
+                          <button class="toggle-source">toggle source</button>
+                          <div class="method-source-code" id="<%= method.html_name %>-source">
+                            <pre><%= method.markup_code %></pre>
+                          </div>
+                        <%- end -%>
+                      </div>
+                    <%- end -%>
+
+                    <%- unless method.aliases.empty? then -%>
+                      <div class="aliases">
+                        Also aliased as: <%= method.aliases.map do |aka|
+                          if aka.parent then # HACK lib/rexml/encodings
+                            %{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
+                          else
+                            h aka.name
+                          end
+                        end.join ", " %>
+                      </div>
+                    <%- end -%>
+
+                    <%- if method.is_alias_for then -%>
+                      <div class="aliases">
+                        Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+                      </div>
+                    <%- end -%>
+                  </div>
+                <%- end -%>
+              </section>
+            <%- end
+              end %>
+        <%- end -%>
+      </article>
+      <nav class="contextual">
+        <%= render '_sidebar_parent.rhtml' %>
+        <%= render '_sidebar_includes.rhtml' %>
+        <%= render '_sidebar_table_of_contents.rhtml' %>
+        <%= render '_sidebar_sections.rhtml' %>
+        <%= render '_sidebar_extends.rhtml' %>
+        <%= render '_sidebar_constants.rhtml' %>
+        <%= render '_sidebar_methods.rhtml' %>
+      </nav>
+    </main>
+  </div>
+</body>