rdoc 4.2.1 → 6.3.1

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

@@ -3,17 +3,20 @@
 <title><%= h @title %></title>
 
 <script type="text/javascript">
-  var rdoc_rel_prefix = "<%= rel_prefix %>/";
+  var rdoc_rel_prefix = "<%= asset_rel_prefix %>/";
+  var index_rel_prefix = "<%= rel_prefix %>/";
 </script>
 
-<script src="<%= asset_rel_prefix %>/js/jquery.js"></script>
-<script src="<%= asset_rel_prefix %>/js/darkfish.js"></script>
+<script src="<%= asset_rel_prefix %>/js/navigation.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/search.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/search_index.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/searcher.js" defer></script>
+<script src="<%= asset_rel_prefix %>/js/darkfish.js" defer></script>
 
 <link href="<%= asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
 <link href="<%= asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
-<% if @options.template_stylesheets.flatten.any? then %>
-<%   @options.template_stylesheets.flatten.each do |stylesheet| %>
+<%- if @options.template_stylesheets.flatten.any? then -%>
+<%-   @options.template_stylesheets.flatten.each do |stylesheet| -%>
 <link href="<%= asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
-<%   end %>
-<% end %>
-
+<%-   end -%>
+<%- end -%>

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

@@ -1,4 +1,4 @@
-<% if !svninfo.empty? then %>
+<%- if !svninfo.empty? then %>
 <div id="file-svninfo-section" class="nav-section">
   <h3>VCS Info</h3>
 
@@ -16,4 +16,4 @@
     </dl>
   </div>
 </div>
-<% end %>
+<%- end -%>

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

@@ -2,8 +2,8 @@
   <h3>Class and Module Index</h3>
 
   <ul class="link-list">
-  <% @modsort.each do |index_klass| %>
+  <%- @modsort.each do |index_klass| -%>
     <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a>
-  <% end %>
+  <%- end -%>
   </ul>
 </div>

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

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

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

@@ -2,8 +2,8 @@
   <h3>Defined In</h3>
 
   <ul>
-<% klass.in_files.each do |tl| %>
+<%- klass.in_files.each do |tl| -%>
     <li><%= h tl.relative_name %>
-<% end %>
+<%- end -%>
   </ul>
 </div>

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

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

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

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

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

@@ -1,12 +1,12 @@
-<% unless klass.method_list.empty? then %>
+<%- unless klass.method_list.empty? then %>
 <!-- Method Quickref -->
 <div id="method-list-section" class="nav-section">
   <h3>Methods</h3>
 
   <ul class="link-list" role="directory">
-    <% klass.each_method do |meth| %>
-    <li <% if meth.calls_super %>class="calls-super" <% end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name %></a>
-    <% end %>
+    <%- klass.each_method do |meth| -%>
+    <li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name -%></a>
+    <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,12 +1,12 @@
-<% simple_files = @files.select { |f| f.text? } %>
-<% unless simple_files.empty? then %>
+<%- simple_files = @files.select { |f| f.text? } %>
+<%- unless simple_files.empty? then -%>
 <div id="fileindex-section" class="nav-section">
   <h3>Pages</h3>
 
   <ul class="link-list">
-  <% simple_files.each do |f| %>
+  <%- simple_files.each do |f| -%>
     <li><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
-  <% end %>
+  <%- end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -1,11 +1,11 @@
-<% if klass.type == 'class' then %>
+<%- if klass.type == 'class' then %>
 <div id="parent-class-section" class="nav-section">
   <h3>Parent</h3>
 
-  <% if klass.superclass and not String === klass.superclass then %>
+  <%- if klass.superclass and not String === klass.superclass then -%>
   <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a>
-  <% else %>
+  <%- else -%>
   <p class="link"><%= klass.superclass %>
-  <% end %>
+  <%- end -%>
 </div>
-<% end %>
+<%- end -%>

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

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

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

@@ -1,4 +1,4 @@
-<% comment = if current.respond_to? :comment_location then
+<%- comment = if current.respond_to? :comment_location then
                current.comment_location
              else
                current.comment
@@ -10,9 +10,9 @@
   <h3>Table of Contents</h3>
 
   <ul class="link-list" role="directory">
-<%   table.each do |heading| %>
+<%-   table.each do |heading| -%>
     <li><a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
-<%   end %>
+<%-   end -%>
   </ul>
 </div>
-<% end %>
+<%- end -%>

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

@@ -25,11 +25,9 @@
     <%= klass.description %>
   </section>
 
-  <% klass.each_section do |section, constants, attributes| %>
-  <% constants = constants.select { |const| const.display? } %>
-  <% attributes = attributes.select { |attr| attr.display? } %>
+  <%- klass.each_section do |section, constants, attributes| -%>
   <section id="<%= section.aref %>" class="documentation-section">
-    <% if section.title then %>
+    <%- if section.title then -%>
     <header class="documentation-section-title">
       <h2>
         <%= section.title %>
@@ -38,39 +36,39 @@
         <a href="#top">&uarr; top</a>
       </span>
     </header>
-    <% end %>
+    <%- end -%>
 
-    <% if section.comment then %>
+    <%- if section.comment then -%>
     <div>
       <%= section.description %>
     </div>
-    <% end %>
+    <%- end -%>
 
-    <% unless constants.empty? then %>
+    <%- unless constants.empty? then -%>
     <section class="constants-list">
       <header>
         <h3>Constants</h3>
       </header>
       <dl>
-      <% constants.each do |const| %>
+      <%- constants.each do |const| -%>
         <dt id="<%= const.name %>"><%= const.name %>
-        <% if const.comment then %>
+        <%- if const.comment then -%>
         <dd><%= const.description.strip %>
-        <% else %>
+        <%- else -%>
         <dd class="missing-docs">(Not documented)
-        <% end %>
-      <% end %>
+        <%- end -%>
+      <%- end -%>
       </dl>
     </section>
-    <% end %>
+    <%- end -%>
 
-    <% unless attributes.empty? then %>
+    <%- unless attributes.empty? then -%>
     <section class="attribute-method-details" class="method-section">
       <header>
         <h3>Attributes</h3>
       </header>
 
-      <% attributes.each do |attrib| %>
+      <%- attributes.each do |attrib| -%>
       <div id="<%= attrib.aref %>" class="method-detail">
         <div class="method-heading attribute-method-heading">
           <span class="method-name"><%= h attrib.name %></span><span
@@ -78,18 +76,18 @@
         </div>
 
         <div class="method-description">
-        <% if attrib.comment then %>
+        <%- if attrib.comment then -%>
         <%= attrib.description.strip %>
-        <% else %>
+        <%- else -%>
         <p class="missing-docs">(Not documented)
-        <% end %>
+        <%- end -%>
         </div>
       </div>
-      <% end %>
+      <%- end -%>
     </section>
-    <% end %>
+    <%- end -%>
 
-    <% klass.methods_by_type(section).each do |type, visibilities|
+    <%- klass.methods_by_type(section).each do |type, visibilities|
        next if visibilities.empty?
        visibilities.each do |visibility, methods|
          next if methods.empty? %>
@@ -98,38 +96,38 @@
          <h3><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
        </header>
 
-    <% methods.each do |method| %>
+    <%- methods.each do |method| -%>
       <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
-        <% if method.call_seq then %>
-        <%   method.call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
+        <%- if (call_seq = method.call_seq) then -%>
+        <%-   call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
         <div class="method-heading">
           <span class="method-callseq">
             <%= h(call_seq.strip.
                   gsub( /^\w+\./m, '')).
                   gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
           </span>
-          <% if i == 0 and method.token_stream then %>
+          <%- if i == 0 and method.token_stream then -%>
           <span class="method-click-advice">click to toggle source</span>
-          <% end %>
+          <%- end -%>
         </div>
-        <%   end %>
-        <% else %>
+        <%-   end -%>
+        <%- else -%>
         <div class="method-heading">
           <span class="method-name"><%= h method.name %></span><span
-            class="method-args"><%= method.param_seq %></span>
-          <% if method.token_stream then %>
+            class="method-args"><%= h method.param_seq %></span>
+          <%- if method.token_stream then -%>
           <span class="method-click-advice">click to toggle source</span>
-          <% end %>
+          <%- end -%>
         </div>
-        <% end %>
+        <%- end -%>
 
         <div class="method-description">
-          <% if method.comment then %>
+          <%- if method.comment then -%>
           <%= method.description.strip %>
-          <% else %>
+          <%- else -%>
           <p class="missing-docs">(Not documented)
-          <% end %>
-          <% if method.calls_super then %>
+          <%- end -%>
+          <%- if method.calls_super then -%>
             <div class="method-calls-super">
               Calls superclass method
               <%=
@@ -137,16 +135,16 @@
                   method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
               %>
             </div>
-          <% end %>
+          <%- end -%>
 
-          <% if method.token_stream then %>
+          <%- if method.token_stream then -%>
           <div class="method-source-code" id="<%= method.html_name %>-source">
             <pre><%= method.markup_code %></pre>
           </div>
-          <% end %>
+          <%- end -%>
         </div>
 
-        <% unless method.aliases.empty? then %>
+        <%- unless method.aliases.empty? then -%>
         <div class="aliases">
           Also aliased as: <%= method.aliases.map do |aka|
             if aka.parent then # HACK lib/rexml/encodings
@@ -156,19 +154,19 @@
             end
           end.join ", " %>
         </div>
-        <% end %>
+        <%- end -%>
 
-        <% if method.is_alias_for then %>
+        <%- 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 %>
+        <%- end -%>
       </div>
 
-    <% end %>
+    <%- end -%>
     </section>
-  <% end
+  <%- end
      end %>
   </section>
-<% end %>
+<%- end -%>
 </main>

data/lib/rdoc/generator/template/darkfish/css/fonts.css

@@ -17,7 +17,7 @@
   font-weight: 400;
   src: local("Source Code Pro"),
        local("SourceCodePro-Regular"),
-       url("fonts/SourceCodePro-Regular.ttf") format("truetype");
+       url("../fonts/SourceCodePro-Regular.ttf") format("truetype");
 }
 
 @font-face {
@@ -26,7 +26,7 @@
   font-weight: 700;
   src: local("Source Code Pro Bold"),
        local("SourceCodePro-Bold"),
-       url("fonts/SourceCodePro-Bold.ttf") format("truetype");
+       url("../fonts/SourceCodePro-Bold.ttf") format("truetype");
 }
 
 /*
@@ -46,7 +46,7 @@
   font-weight: 300;
   src: local("Lato Light"),
        local("Lato-Light"),
-       url("fonts/Lato-Light.ttf") format("truetype");
+       url("../fonts/Lato-Light.ttf") format("truetype");
 }
 
 @font-face {
@@ -55,7 +55,7 @@
   font-weight: 300;
   src: local("Lato Light Italic"),
        local("Lato-LightItalic"),
-       url("fonts/Lato-LightItalic.ttf") format("truetype");
+       url("../fonts/Lato-LightItalic.ttf") format("truetype");
 }
 
 @font-face {
@@ -64,7 +64,7 @@
   font-weight: 700;
   src: local("Lato Regular"),
        local("Lato-Regular"),
-       url("fonts/Lato-Regular.ttf") format("truetype");
+       url("../fonts/Lato-Regular.ttf") format("truetype");
 }
 
 @font-face {
@@ -73,7 +73,7 @@
   font-weight: 700;
   src: local("Lato Italic"),
        local("Lato-Italic"),
-       url("fonts/Lato-RegularItalic.ttf") format("truetype");
+       url("../fonts/Lato-RegularItalic.ttf") format("truetype");
 }
 
 /*

data/lib/rdoc/generator/template/darkfish/css/rdoc.css

@@ -9,6 +9,8 @@
 /* vim: ft=css et sw=2 ts=2 sts=2 */
 /* Base Green is: #6C8C22 */
 
+.hide { display: none !important; }
+
 * { padding: 0; margin: 0; }
 
 body {
@@ -48,6 +50,16 @@ h6:hover span {
   display: inline;
 }
 
+h1:target,
+h2:target,
+h3:target,
+h4:target,
+h5:target,
+h6:target {
+  margin-left: -10px;
+  border-left: 10px solid #f1edba;
+}
+
 :link,
 :visited {
   color: #6C8C22;
@@ -62,6 +74,28 @@ h6:hover span {
 code,
 pre {
   font-family: "Source Code Pro", Monaco, monospace;
+  background-color: rgba(27,31,35,0.05);
+  padding: 0em 0.2em;
+  border-radius: 0.2em;
+}
+
+table {
+  margin: 0;
+  border-spacing: 0;
+  border-collapse: collapse;
+}
+
+table tr th, table tr td {
+  padding: 0.2em 0.4em;
+  border: 1px solid #ccc;
+}
+
+table tr th {
+  background-color: #eceaed;
+}
+
+table tr:nth-child(even) td {
+  background-color: #f5f4f6;
 }
 
 /* @group Generic Classes */
@@ -91,7 +125,7 @@ pre {
 
 .missing-docs {
   font-size: 120%;
-  background: white url(images/wrench_orange.png) no-repeat 4px center;
+  background: white url(../images/wrench_orange.png) no-repeat 4px center;
   color: #ccc;
   line-height: 2em;
   border: 1px solid #d00;
@@ -135,11 +169,11 @@ pre {
 .table-of-contents li .toc-toggle {
   width: 16px;
   height: 16px;
-  background: url(images/add.png) no-repeat;
+  background: url(../images/add.png) no-repeat;
 }
 
 .table-of-contents li .toc-toggle.open {
-  background: url(images/delete.png) no-repeat;
+  background: url(../images/delete.png) no-repeat;
 }
 
 /* @end */
@@ -151,6 +185,7 @@ nav {
   width: 260px;
   font-family: Helvetica, sans-serif;
   font-size: 14px;
+  border-right: 1px solid #ccc;
 }
 
 main {
@@ -261,8 +296,13 @@ ul.link-list .type {
   -webkit-border-radius: 5px;
 }
 
+dl.note-list dt {
+  float: left;
+  margin-right: 1em;
+}
+
 .calls-super {
-  background: url(images/arrow_up.png) no-repeat right center;
+  background: url(../images/arrow_up.png) no-repeat right center;
 }
 
 /* @end */
@@ -441,7 +481,16 @@ main header h3 {
 /* @group Method Details */
 
 main .method-source-code {
-  display: none;
+  max-height: 0;
+  overflow: hidden;
+  transition-duration: 200ms;
+  transition-delay: 0ms;
+  transition-property: all;
+  transition-timing-function: ease-in-out;
+}
+
+main .method-source-code.active-menu {
+  max-height: 100vh;
 }
 
 main .method-description .method-calls-super {
@@ -479,7 +528,7 @@ main .method-click-advice {
   visibility: hidden;
   padding-right: 20px;
   line-height: 20px;
-  background: url(images/zoom.png) no-repeat right top;
+  background: url(../images/zoom.png) no-repeat right top;
 }
 main .method-heading:hover .method-click-advice {
   visibility: visible;

data/lib/rdoc/generator/template/darkfish/index.rhtml

@@ -13,11 +13,10 @@
 </nav>
 
 <main role="main">
-<% if @options.main_page and
+<%- if @options.main_page and
       main_page = @files.find { |f| f.full_name == @options.main_page } then %>
 <%= main_page.description %>
-<% else %>
+<%- else -%>
 <p>This is the API documentation for <%= @title %>.
-<% end %>
+<%- end -%>
 </main>
-