gitlab-rdoc 6.3.2

data/lib/rdoc/generator/template/darkfish/_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/darkfish/_sidebar_classes.rhtml

@@ -0,0 +1,9 @@
+<div id="classindex-section" class="nav-section">
+  <h3>Class and Module Index</h3>
+
+  <ul class="link-list">
+  <%- @modsort.each do |index_klass| -%>
+    <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a>
+  <%- end -%>
+  </ul>
+</div>

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

@@ -0,0 +1,15 @@
+<%- 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 -%>
+    <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/darkfish/_sidebar_in_files.rhtml

@@ -0,0 +1,9 @@
+<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/darkfish/_sidebar_includes.rhtml

@@ -0,0 +1,15 @@
+<%- 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 -%>
+    <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/darkfish/_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/darkfish/_sidebar_methods.rhtml

@@ -0,0 +1,12 @@
+<%- 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 -%>
+  </ul>
+</div>
+<%- end -%>

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

@@ -0,0 +1,11 @@
+<div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="<%= rel_prefix %>/index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="<%= rel_prefix %>/table_of_contents.html#pages">Pages</a>
+    <a href="<%= rel_prefix %>/table_of_contents.html#classes">Classes</a>
+    <a href="<%= rel_prefix %>/table_of_contents.html#methods">Methods</a>
+  </div>
+</div>

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

@@ -0,0 +1,12 @@
+<%- 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| -%>
+    <li><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
+  <%- end -%>
+  </ul>
+</div>
+<%- end -%>

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

@@ -0,0 +1,11 @@
+<%- 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 -%>
+  <p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a>
+  <%- else -%>
+  <p class="link"><%= klass.superclass %>
+  <%- end -%>
+</div>
+<%- end -%>

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

@@ -0,0 +1,14 @@
+<div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" 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>
+</div>

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

@@ -0,0 +1,11 @@
+<%- 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| -%>
+      <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
+    <%- end -%>
+  </ul>
+</div>
+<%- end -%>

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

@@ -0,0 +1,18 @@
+<%- comment = if current.respond_to? :comment_location then
+               current.comment_location
+             else
+               current.comment
+             end
+   table = current.parse(comment).table_of_contents
+
+   if table.length > 1 then %>
+<div class="nav-section">
+  <h3>Table of Contents</h3>
+
+  <ul class="link-list" role="directory">
+<%-   table.each do |heading| -%>
+    <li><a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
+<%-   end -%>
+  </ul>
+</div>
+<%- end -%>

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

@@ -0,0 +1,172 @@
+<body id="top" role="document" class="<%= klass.type %>">
+<nav role="navigation">
+  <div id="project-navigation">
+    <%= render '_sidebar_navigation.rhtml' %>
+    <%= render '_sidebar_search.rhtml' %>
+  </div>
+
+  <%= render '_sidebar_table_of_contents.rhtml' %>
+
+  <div id="class-metadata">
+    <%= render '_sidebar_sections.rhtml' %>
+    <%= render '_sidebar_parent.rhtml' %>
+    <%= render '_sidebar_includes.rhtml' %>
+    <%= render '_sidebar_extends.rhtml' %>
+    <%= render '_sidebar_methods.rhtml' %>
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="<%=h klass.aref %>">
+  <h1 id="<%=h klass.aref %>" class="<%= klass.type %>">
+    <%= klass.type %> <%= klass.full_name %>
+  </h1>
+
+  <section class="description">
+    <%= klass.description %>
+  </section>
+
+  <%- klass.each_section do |section, constants, attributes| -%>
+  <section id="<%= section.aref %>" class="documentation-section">
+    <%- if section.title then -%>
+    <header class="documentation-section-title">
+      <h2>
+        <%= section.title %>
+      </h2>
+      <span class="section-click-top">
+        <a href="#top">&uarr; top</a>
+      </span>
+    </header>
+    <%- end -%>
+
+    <%- if section.comment then -%>
+    <div>
+      <%= section.description %>
+    </div>
+    <%- end -%>
+
+    <%- unless constants.empty? then -%>
+    <section class="constants-list">
+      <header>
+        <h3>Constants</h3>
+      </header>
+      <dl>
+      <%- constants.each do |const| -%>
+        <dt id="<%= const.name %>"><%= const.name %>
+        <%- if const.comment then -%>
+        <dd><%= const.description.strip %>
+        <%- else -%>
+        <dd class="missing-docs">(Not documented)
+        <%- end -%>
+      <%- end -%>
+      </dl>
+    </section>
+    <%- end -%>
+
+    <%- unless attributes.empty? then -%>
+    <section class="attribute-method-details" class="method-section">
+      <header>
+        <h3>Attributes</h3>
+      </header>
+
+      <%- 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
+            class="attribute-access-type">[<%= attrib.rw %>]</span>
+        </div>
+
+        <div class="method-description">
+        <%- if attrib.comment then -%>
+        <%= attrib.description.strip %>
+        <%- else -%>
+        <p class="missing-docs">(Not documented)
+        <%- 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>
+         <h3><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
+       </header>
+
+    <%- methods.each do |method| -%>
+      <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
+        <%- 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 -%>
+          <span class="method-click-advice">click to toggle source</span>
+          <%- end -%>
+        </div>
+        <%-   end -%>
+        <%- else -%>
+        <div class="method-heading">
+          <span class="method-name"><%= h method.name %></span><span
+            class="method-args"><%= h method.param_seq %></span>
+          <%- if method.token_stream then -%>
+          <span class="method-click-advice">click to toggle source</span>
+          <%- end -%>
+        </div>
+        <%- end -%>
+
+        <div class="method-description">
+          <%- if method.comment then -%>
+          <%= method.description.strip %>
+          <%- else -%>
+          <p class="missing-docs">(Not documented)
+          <%- 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 -%>
+          <div class="method-source-code" id="<%= method.html_name %>-source">
+            <pre><%= method.markup_code %></pre>
+          </div>
+          <%- end -%>
+        </div>
+
+        <%- 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 %>
+  </section>
+<%- end -%>
+</main>

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

@@ -0,0 +1,167 @@
+/*
+ * Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/),
+ * with Reserved Font Name "Source". All Rights Reserved. Source is a
+ * trademark of Adobe Systems Incorporated in the United States and/or other
+ * countries.
+ *
+ * This Font Software is licensed under the SIL Open Font License, Version
+ * 1.1.
+ *
+ * This license is copied below, and is also available with a FAQ at:
+ * http://scripts.sil.org/OFL
+ */
+
+@font-face {
+  font-family: "Source Code Pro";
+  font-style: normal;
+  font-weight: 400;
+  src: local("Source Code Pro"),
+       local("SourceCodePro-Regular"),
+       url("../fonts/SourceCodePro-Regular.ttf") format("truetype");
+}
+
+@font-face {
+  font-family: "Source Code Pro";
+  font-style: normal;
+  font-weight: 700;
+  src: local("Source Code Pro Bold"),
+       local("SourceCodePro-Bold"),
+       url("../fonts/SourceCodePro-Bold.ttf") format("truetype");
+}
+
+/*
+ * Copyright (c) 2010, Łukasz Dziedzic (dziedzic@typoland.com),
+ * with Reserved Font Name Lato.
+ *
+ * This Font Software is licensed under the SIL Open Font License, Version
+ * 1.1.
+ *
+ * This license is copied below, and is also available with a FAQ at:
+ * http://scripts.sil.org/OFL
+ */
+
+@font-face {
+  font-family: "Lato";
+  font-style: normal;
+  font-weight: 300;
+  src: local("Lato Light"),
+       local("Lato-Light"),
+       url("../fonts/Lato-Light.ttf") format("truetype");
+}
+
+@font-face {
+  font-family: "Lato";
+  font-style: italic;
+  font-weight: 300;
+  src: local("Lato Light Italic"),
+       local("Lato-LightItalic"),
+       url("../fonts/Lato-LightItalic.ttf") format("truetype");
+}
+
+@font-face {
+  font-family: "Lato";
+  font-style: normal;
+  font-weight: 700;
+  src: local("Lato Regular"),
+       local("Lato-Regular"),
+       url("../fonts/Lato-Regular.ttf") format("truetype");
+}
+
+@font-face {
+  font-family: "Lato";
+  font-style: italic;
+  font-weight: 700;
+  src: local("Lato Italic"),
+       local("Lato-Italic"),
+       url("../fonts/Lato-RegularItalic.ttf") format("truetype");
+}
+
+/*
+ * -----------------------------------------------------------
+ * SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+ * -----------------------------------------------------------
+ *
+ * PREAMBLE
+ * The goals of the Open Font License (OFL) are to stimulate worldwide
+ * development of collaborative font projects, to support the font creation
+ * efforts of academic and linguistic communities, and to provide a free and
+ * open framework in which fonts may be shared and improved in partnership
+ * with others.
+ *
+ * The OFL allows the licensed fonts to be used, studied, modified and
+ * redistributed freely as long as they are not sold by themselves. The
+ * fonts, including any derivative works, can be bundled, embedded,
+ * redistributed and/or sold with any software provided that any reserved
+ * names are not used by derivative works. The fonts and derivatives,
+ * however, cannot be released under any other type of license. The
+ * requirement for fonts to remain under this license does not apply
+ * to any document created using the fonts or their derivatives.
+ *
+ * DEFINITIONS
+ * "Font Software" refers to the set of files released by the Copyright
+ * Holder(s) under this license and clearly marked as such. This may
+ * include source files, build scripts and documentation.
+ *
+ * "Reserved Font Name" refers to any names specified as such after the
+ * copyright statement(s).
+ *
+ * "Original Version" refers to the collection of Font Software components as
+ * distributed by the Copyright Holder(s).
+ *
+ * "Modified Version" refers to any derivative made by adding to, deleting,
+ * or substituting -- in part or in whole -- any of the components of the
+ * Original Version, by changing formats or by porting the Font Software to a
+ * new environment.
+ *
+ * "Author" refers to any designer, engineer, programmer, technical
+ * writer or other person who contributed to the Font Software.
+ *
+ * PERMISSION & CONDITIONS
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of the Font Software, to use, study, copy, merge, embed, modify,
+ * redistribute, and sell modified and unmodified copies of the Font
+ * Software, subject to the following conditions:
+ *
+ * 1) Neither the Font Software nor any of its individual components,
+ * in Original or Modified Versions, may be sold by itself.
+ *
+ * 2) Original or Modified Versions of the Font Software may be bundled,
+ * redistributed and/or sold with any software, provided that each copy
+ * contains the above copyright notice and this license. These can be
+ * included either as stand-alone text files, human-readable headers or
+ * in the appropriate machine-readable metadata fields within text or
+ * binary files as long as those fields can be easily viewed by the user.
+ *
+ * 3) No Modified Version of the Font Software may use the Reserved Font
+ * Name(s) unless explicit written permission is granted by the corresponding
+ * Copyright Holder. This restriction only applies to the primary font name as
+ * presented to the users.
+ *
+ * 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+ * Software shall not be used to promote, endorse or advertise any
+ * Modified Version, except to acknowledge the contribution(s) of the
+ * Copyright Holder(s) and the Author(s) or with their explicit written
+ * permission.
+ *
+ * 5) The Font Software, modified or unmodified, in part or in whole,
+ * must be distributed entirely under this license, and must not be
+ * distributed under any other license. The requirement for fonts to
+ * remain under this license does not apply to any document created
+ * using the Font Software.
+ *
+ * TERMINATION
+ * This license becomes null and void if any of the above conditions are
+ * not met.
+ *
+ * DISCLAIMER
+ * THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+ * OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+ * COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+ * DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+ * OTHER DEALINGS IN THE FONT SOFTWARE.
+ */
+