rdoc-generator-sixfish 0.3.1 → 0.5.0.pre20180710102525

data/data/rdoc-generator-sixfish/templates/class.tmpl

@@ -1,211 +1,212 @@
 <?import rel_prefix, modsort, files ?>
 
-<header>
-<?if klass.parent ?>
-	<?if klass.full_name.index('::') ?>
-	<h2 class="namespace">
-	<?call klass.full_name.sub(/^(.*::).*/, '\1') ?>
-	</h2>
-	<?end if ?>
-	<h1 class="[?call klass.type ?] title is-1">
-		<span class="name"><?call klass.name ?></span>
-			<span class="tag is-info"><?call klass.type ?></span>
-	</h1>
-<?end if ?>
-</header>
-
-<table class="class-metadata table box">
-	<tbody>
-		<?unless klass.module? ?>
-		<tr>
-			<td>Superclass</td>
-			<?if klass.superclass.respond_to?(:path) ?>
-			<td class="superclass"><a href="[?attr rel_prefix ?]/[?call klass.superclass.path ?]"><?call
-				klass.superclass.full_name ?></a></td>
-			<?else?>
-			<td class="superclass"><?call klass.superclass ?></td>
-			<?end if ?>
-		</tr>
-		<?end unless ?>
-
-		<?unless klass.includes.empty? ?>
-		<tr>
-			<td>Included Modules</td>
-			<td class="included-modules">
-				<ul>
-				<?for inc in klass.includes ?>
-					<?if inc.module.respond_to?(:path) ?>
-					<li class="include"><a href="[?call klass.aref_to(inc.module.path) ?]"><?call
-						inc.module.full_name ?></a></li>
-					<?else ?>
-					<li class="include"><?call inc.name ?></li>
+<div class="row">
+	<div class="one-half column">
+
+		<header class="hero-unit">
+			<hgroup>
+				<?if klass.parent ?>
+					<?if klass.full_name.index('::') ?>
+					<h2 class="namespace">
+					<?call klass.full_name.sub(/^(.*::).*/, '\1') ?>
+					</h2>
 					<?end if ?>
-				<?end for ?>
-				</ul>
-			</td>
-		</tr>
-		<?end unless ?>
-
-		<?unless klass.extends.empty? ?>
-		<tr>
-			<td>Extended With</td>
-			<td class="extended-modules">
-				<ul>
-				<?for ext in klass.extends.uniq ?>
-					<?if ext.module.respond_to?(:path) ?>
-					<li class="extend"><a href="[?call klass.aref_to(ext.module.path) ?]"><?call
-						ext.module.full_name ?></a></li>
-					<?else ?>
-					<li class="extend"><?call ext.name ?></li>
-					<?end if ?>
-				<?end for ?>
-			</td>
-		</tr>
-		<?end unless ?>
-
-	</tbody>
-</table>
-
-<?call klass.description ?>
-</section>
-
-
-<section class="api content">
-
-<?for section, constants, attrs in klass.each_section ?>
-<div id="<?call section.aref ?>">
-	<?if section.title ?>
-		<header>
-			<h3 class="title is-3"><?call section.title ?></h3>
-			<span class="section-click-top">
-				<a href="#top">&uarr; top</a>
-			</span>
+				<?end if ?>
+				<?if klass.in_files.empty? ?>
+				<h1 class="[?call klass.type ?]"><?call klass.name ?></h1>
+				<?else?>
+				<h1 class="[?call klass.type ?]"
+					title="In files: "
+					data-tooltip="[?call klass.in_files.map {|f| f.full_name }.join(', ') ?]"
+					><span class="name"><?call klass.name ?></span></h1>
+				<?end if ?>
+			</hgroup>
+			<span class="label"><?call klass.type ?></span>
 		</header>
-	<?end if ?>
-
-   <?if section.comment ?>
-    <p class="description">
-		<?call section.description ?>
-    </p>
-   <?end if ?>
 
-	<?if constants.any?{|c| c.display? } ?>
-		<!-- Constants -->
-		<section class="constants-list">
-			<header>
-				<h3>Constants</h3>
-			</header>
+		<section class="description">
+			<?call klass.description ?>
+		</section>
+	</div>
+
+	<div class="one-half column">
+		<section class="module-relations">
+			<dl>
+				<?unless klass.module? ?>
+				<dt>Superclass</dt>
+				<?if klass.superclass.respond_to?(:path) ?>
+				<dd class="superclass"><a href="[?attr rel_prefix ?]/[?call klass.superclass.path ?]"><?call
+					klass.superclass.full_name ?></a></dd>
+				<?else?>
+				<dd class="superclass"><?call klass.superclass ?></dd>
+				<?end if ?>
+				<?end unless ?>
 
-			<dl class="constants">
-			<?for const in constants.select {|c| c.display? } ?>
-				<dt id="[?call const.name ?]"><i class="icon-generic"></i><?call const.name ?></dt>
-				<?if const.comment ?>
-				<dd class="description"><?call const.description.strip ?></dd>
+				<?unless klass.includes.empty? ?>
+				<dt>Included Modules</dt>
+				<?for inc in klass.includes ?>
+				<?if inc.module.respond_to?(:path) ?>
+				<dd class="include"><a href="[?call klass.aref_to(inc.module.path) ?]"><?call
+					inc.module.full_name ?></a></dd>
 				<?else ?>
-				<dd class="description missing-docs">(Not documented)</dd>
-				<?end ?>
-			<?end ?>
-			</dl>
-
-		</section>
-	<?end ?>
+				<dd class="include"><?call inc.name ?></dd>
+				<?end if ?>
+				<?end for ?>
+				<?end unless ?>
 
-	<?if attrs.any?{|a| a.display? } ?>
-		<!-- Attributes -->
-		<section class="attributes-list">
-			<header>
-				<h3>Attributes</h3>
-			</header>
-			<dl class="attributes">
-			<?for attrib in attrs.select {|a| a.display? } ?>
-				<dt id="[?call attrib.aref ?]"><i class="icon-generic"></i><?call attrib.name ?> <span
-					class="attribute-access-type [?call attrib.rw.downcase ?]"><?call 
-						attrib.rw ?></span></dt>
-				<?if attrib.comment ?>
-				<dd class="description"><?call attrib.description.strip ?></dd>
+				<?unless klass.extends.empty? ?>
+				<dt>Extended With</dt>
+				<?for ext in klass.extends.uniq ?>
+				<?if ext.module.respond_to?(:path) ?>
+				<dd class="extend"><a href="[?call klass.aref_to(ext.module.path) ?]"><?call
+					ext.module.full_name ?></a></dd>
 				<?else ?>
-				<dd class="description missing-docs">(Not documented)</dd>
-				<?end ?>
-			<?end ?>
+				<dd class="extend"><?call ext.name ?></dd>
+				<?end if ?>
+				<?end for ?>
+				<?end unless ?>
 			</dl>
 		</section>
-	<?end if ?>
+	</div>
+</div>
 
-		<!-- Methods -->
-	<?for scope, visibilities in klass.methods_by_type( section ) ?>
-		<?for visibility, methodlist in visibilities ?>
 
-		<?unless methodlist.empty? ?>
-		<section class="[?attr visibility ?]-methods [?attr scope ?]-methods methods">
+<div class="row">
+	<div class="column">
+
+		<?for section, constants, attrs in klass.each_section ?>
+		<section id="<?call section.aref ?>" class="documentation-section">
+			<?if section.title ?>
 			<header>
-				<h3><?call visibility.to_s.capitalize ?> <?call scope.capitalize ?> Methods</h3>
+				<h2><?call section.title ?></h2>
+				<span class="section-click-top">
+					<a href="#top">&uarr; top</a>
+				</span>
 			</header>
+			<?end if ?>
 
-			<?for meth in methodlist ?>
-			<a name="[?call meth.aref ?]"></a>
-			<div id="<?call meth.aref ?>-doc" class="method[?if meth.is_alias_for
-				?] method-alias[?end if ?]">
+		    <?if section.comment ?>
+		    <section class="description">
+				<?call section.description ?>
+		    </section>
+		    <?end if ?>
 
+			<?if constants.any?{|c| c.display? } ?>
+			<!-- Constants -->
+			<section class="constants-list">
 				<header>
-				<?if meth.call_seq ?>
-					<?for call_seq, i in meth.call_seq.strip.split("\n") ?>
-					<i class="fas fa-chevron-right"></i>
-					<span class="method-callseq"
-          ><?call
-          call_seq.strip.gsub( /^\w+\./m, '').gsub(/->/, '&rarr;')
-           ?></span><br />
-					<?end for ?>
-				<?else ?>
-					<i class="fas fa-chevron-right"></i>
-					<span class="method-name"><?escape meth.name ?></span><span 
-						class="method-args"><?escape meth.param_seq ?></span>
-				<?end if ?>
+					<h3>Constants</h3>
 				</header>
+				<dl>
+				<?for const in constants.select {|c| c.display? } ?>
+					<dt id="[?call const.name ?]"><i class="icon-generic"></i><?call const.name ?></dt>
+					<?if const.comment ?>
+					<dd class="description"><?call const.description.strip ?></dd>
+					<?else ?>
+					<dd class="description missing-docs">(Not documented)</dd>
+					<?end ?>
+				<?end ?>
+				</dl>
+			</section>
+			<?end ?>
 
-				<div class="method-description">
-				<?if meth.comment ?>
-					<?call meth.description.strip ?>
-				<?else ?>
-					<p class="missing-docs">(Not documented)</p>
+			<?if attrs.any?{|a| a.display? } ?>
+			<!-- Attributes -->
+			<section class="attributes-list">
+				<header>
+					<h3>Attributes</h3>
+				</header>
+				<dl>
+				<?for attrib in attrs.select {|a| a.display? } ?>
+					<dt id="[?call attrib.aref ?]"><i class="icon-generic"></i><?call attrib.name ?> <span
+						class="attribute-access-type [?call attrib.rw.downcase ?]"><?call 
+							attrib.rw ?></span></dt>
+					<?if attrib.comment ?>
+					<dd class="description"><?call attrib.description.strip ?></dd>
+					<?else ?>
+					<dd class="description missing-docs">(Not documented)</dd>
+					<?end ?>
 				<?end ?>
+				</dl>
+			</section>
+			<?end if ?>
 
-				<?if meth.token_stream ?>
-					<div class="method-source-code message" id="[?call meth.html_name ?]-source">
-						<pre class="prettyprint linenums message-body"><code 
-							class="language-ruby"><?call meth.markup_code ?></code></pre>
+			<!-- Methods -->
+			<?for scope, visibilities in klass.methods_by_type( section ) ?>
+			<?for visibility, methodlist in visibilities ?>
+
+			<?unless methodlist.empty? ?>
+			<section class="[?attr visibility ?]-methods [?attr scope ?]-methods methods">
+				<header>
+					<h3><?call visibility.to_s.capitalize ?> <?call scope.capitalize ?> Methods</h3>
+				</header>
+
+				<?for meth in methodlist ?>
+				<a name="[?call meth.aref ?]">anchor</a>
+				<div id="<?call meth.aref ?>-doc" class="method[?if meth.is_alias_for
+					?] method-alias[?end if ?]">
+
+					<header>
+					<?if meth.call_seq ?>
+						<?for call_seq, i in meth.call_seq.strip.split("\n") ?>
+						<i class="icon-generic"></i>
+						<span class="method-callseq"
+              ><?call
+              call_seq.strip.gsub( /^\w+\./m, '').gsub(/->/, '&rarr;')
+               ?></span><br />
+						<?end for ?>
+					<?else ?>
+						<i class="icon-generic"></i>
+						<span class="method-name"><?escape meth.name ?></span><span 
+							class="method-args"><?escape meth.param_seq ?></span>
+					<?end if ?>
+					</header>
+
+					<div class="method-description">
+					<?if meth.comment ?>
+						<?call meth.description.strip ?>
+					<?else ?>
+						<p class="missing-docs">(Not documented)</p>
+					<?end ?>
+
+					<?if meth.token_stream ?>
+						<div class="method-source-code" id="[?call meth.html_name ?]-source">
+							<pre class="prettyprint linenums"><code 
+								class="language-ruby"><?call meth.markup_code ?></code></pre>
+						</div>
+					<?end ?>
 					</div>
-				<?end ?>
-				</div>
 
-				<?unless meth.aliases.empty? ?>
-				<div class="aliases">
-					Also aliased as:
-					<?for aka in meth.aliases ?>
-						<?if aka.parent ?>
-						<a href="[?call klass.aref_to(aka.path) ?]"><?escape aka.name ?></a>
-						<?else ?>
-						<?escape aka.name ?>
-						<?end if ?><?unless aka == meth.aliases.last ?>, <?end unless ?>
-					<?end for ?>
-				</div>
-				<?end ?>
+					<?unless meth.aliases.empty? ?>
+					<div class="aliases">
+						Also aliased as:
+						<?for aka in meth.aliases ?>
+							<?if aka.parent ?>
+							<a href="[?call klass.aref_to(aka.path) ?]"><?escape aka.name ?></a>
+							<?else ?>
+							<?escape aka.name ?>
+							<?end if ?><?unless aka == meth.aliases.last ?>, <?end unless ?>
+						<?end for ?>
+					</div>
+					<?end ?>
 
-				<?if meth.is_alias_for ?>
-				<div class="aliases">
-					Alias for: <a href="[?call klass.aref_to( meth.is_alias_for.path ) 
-						?]"><?escape meth.is_alias_for.name ?></a>
+					<?if meth.is_alias_for ?>
+					<div class="aliases">
+						Alias for: <a href="[?call klass.aref_to( meth.is_alias_for.path ) 
+							?]"><?escape meth.is_alias_for.name ?></a>
+					</div>
+					<?end if ?>
 				</div>
-				<?end if ?>
-			</div>
+				<?end for ?>
+
+			</section>
+			<?end unless ?>
+
+			<?end for ?>
 			<?end for ?>
 
 		</section>
-		<?end unless ?>
-
 		<?end for ?>
-	<?end for ?>
-		</section>
 
-<?end for ?>
+	</div>
 </div>
-

data/data/rdoc-generator-sixfish/templates/file.tmpl

@@ -1,8 +1,20 @@
 <?import rel_prefix, modsort, files ?>
 
-<header>
-	<h1 class="title is-1"><?strip header ?></h1>
-</header>
+<div class="row">
+	<div class="column">
 
-<?attr description ?>
+		<header class="hero-unit">
+		<?if header =~ /<h\d/ ?>
+			<?attr header ?>
+		<?else?>
+			<h1><?attr header ?></h1>
+		<?end if ?>
+		</header>
+
+		<section class="description">
+			<?attr description ?>
+		</section>
+
+	</div>
+</div>
 

data/data/rdoc-generator-sixfish/templates/index.tmpl

@@ -1,83 +1,54 @@
-<!DOCTYPE html>
-<html>
-<head>
-	<meta charset="utf-8">
-
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-
-	<title><?escape rdoc_options.title ?></title>
-
-	<meta name="description" content="API documentation for [?escape rdoc_options.title ?]">
-	<meta name="author" content="">
-
-	<meta name="viewport" content="width=device-width, initial-scale=1">
-
-	<link rel="icon" type="image/png" href="[?attr rel_prefix ?]/images/favicon.png">
-	<link rel="prefix" href="[?attr rel_prefix ?]" />
-
-	<link rel="stylesheet" href="[?attr rel_prefix ?]/css/sixfish.css">
-</head>
-<body>
-
-	<main class="section">
-
-			<div class="content container">
-				<header>
-					<h1 class="title is-1"><?escape rdoc_options.title ?></h1>
-				</header>
-
-				<?if synopsis ?>
-				<?attr synopsis ?>
-				<?else ?>
-				<p>This is the API documentation for <?escape rdoc_options.title ?>.</p>
-
-				<p>Starting points:</p>
-				<?end if ?>
-
-				<div class="columns is-gapless is-desktop">
-
-					<div class="column">
-						<header>
-							<h2 class="title is-2">Files</h2>
-						</header>
-
-						<ul class="files">
-        					<?if mainpage ?>
-        					<li><a href="[?attr rel_prefix ?]/[?call mainpage.path ?]"><?escape
-        							mainpage.page_name ?></a></li>
-        					<?end if ?>
-							<?for file in files.select {|f| f.text? }.sort ?>
-							<li><a href="[?attr rel_prefix ?]/[?call file.path ?]"><?escape 
-                                file.page_name ?></a></li>
-							<?end for ?>
-						</ul>
-					</div>
-
-
-					<div class="column">
-						<header>
-							<h2 class="title is-2">Classes/Modules</h2>
-						</header>
-
-						<ul class="classes">
-							<?for index_class in modsort.select( &:documented? ).uniq {|c| c.path } ?>
-							<li><a href="[?attr rel_prefix ?]/[?call index_class.path ?]"><?call
-									index_class.full_name ?></a> </li>
-							<?end for ?>
-						</ul>
-					</div>
+<?import rel_prefix, modsort, methods, files ?>
+
+<div class="row">
+	<div class="column">
+
+		<header>
+			<?attr synopsis ?>
+			<?if mainpage ?>
+			<p><a class="btn btn-primary btn-large" 
+				href="[?call mainpage.path ?]">Learn more &raquo;</a></p>
+			<?end if ?>
+		</header>
+
+		<!-- Indexes -->
+		<section id="indexes" class="row">
+			<div class="span4">
+				<ul id="class-index" class="nav nav-list">
+					<li class="nav-header">Classes/Modules</li>
+				<?for index_class in modsort.select( &:documented? ).uniq {|c| c.path } ?>
+					<li><a href="[?attr rel_prefix ?]/[?call index_class.path ?]"
+						title="[?call index_class.full_name ?]"><?call 
+						index_class.full_name.gsub(/(.+?)(?=::)/, '<span class="ns">\\1</span>') ?></a></li>
+				<?end for ?>
+				</ul>
+			</div>
 
-				</div>
+			<div class="span4">
+				<ul id="method-index" class="nav nav-list">
+					<li class="nav-header">Methods</li>
+				<?for method in methods.uniq {|m| m.path } ?>
+					<li class="method"><a title="[?call method.parent.full_name ?]"
+						href="[?call method.path ?]"><?call method.pretty_name ?>
+						<span class="method-parent">[<?call 
+							method.parent.full_name.sub(/.*(::)/, '\\1') ?>]</span>
+						</a>
+					</li>
+				<?end for ?>
+				</ul>
 			</div>
 
-	</main>
+			<div class="span4">
+				<ul id="file-index" class="nav nav-list">
+					<li class="nav-header">Files</li>
+				<?for file in files.select {|f| f.text? }.sort ?>
+					<li class="file"><a href="[?call file.path ?]"><?escape file.page_name ?></a></li>
+				<?end for ?>
+				</ul>
+			</div>
 
-	<footer class="footer">
-		<span id="rdoc-version">Generated by RDoc <?attr rdoc_version ?></span> using the
-		<a id="generator-version"
-			href="https://hg.sr.ht/~ged/Sixfish"><?attr sixfish_version ?></a> generator.
-	</footer>
+		</section>
 
-</body>
-</html>
+	</div>
+</div>