Skip to content

Commit

Permalink
Compiled docs with newer rdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@MaxLap
MaxLap committed May 18, 2024
1 parent 2c1bdf9 commit 7402559
Show file tree
Hide file tree
Showing 12 changed files with 162 additions and 75 deletions.
4 changes: 2 additions & 2 deletions docs/ActiveRecordWhereAssoc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h2>
<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"
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>

Expand Down Expand Up @@ -88,7 +88,7 @@ <h1 id="module-ActiveRecordWhereAssoc" class="module">

<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

59 changes: 38 additions & 21 deletions docs/ActiveRecordWhereAssoc/RelationReturningMethods.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h2>
<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"
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>

Expand All @@ -58,14 +58,25 @@ <h2>
<div class="nav-section">
<h3>Table of Contents</h3>



<ul class="link-list" role="directory">
<li><a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-Association">Association</a>
<li><a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-Condition">Condition</a>
<li><a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-Block">Block</a>
<li><a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-Options">Options</a>
<li><a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-3Aignore_limit+option">:ignore_limit option</a>
<li><a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-3Anever_alias_limit+option">:never_alias_limit option</a>
<li><a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-3Apoly_belongs_to+option">:poly_belongs_to option</a>
<li> <a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-Association">Association</a>
<li> <a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-Condition">Condition</a>
<li> <a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-Block">Block</a>
<li>
<details open>
<summary> <a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-Options">Options</a>
</summary>
<ul class="link-list" role="directory">
<li> <a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-3Aignore_limit+option">:ignore_limit option</a>
<li> <a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-3Anever_alias_limit+option">:never_alias_limit option</a>
<li> <a href="#module-ActiveRecordWhereAssoc::RelationReturningMethods-label-3Apoly_belongs_to+option">:poly_belongs_to option</a>

</ul>
</details>
</li>

</ul>
</div>

Expand Down Expand Up @@ -337,10 +348,12 @@ <h3>Public Instance Methods</h3>
</header>

<div id="method-i-where_assoc_exists" class="method-detail ">
<div class="method-heading">
<span class="method-name">where_assoc_exists</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">where_assoc_exists</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand Down Expand Up @@ -391,10 +404,12 @@ <h3>Public Instance Methods</h3>
</div>

<div id="method-i-where_assoc_not_exists" class="method-detail ">
<div class="method-heading">
<span class="method-name">where_assoc_not_exists</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">where_assoc_not_exists</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand Down Expand Up @@ -469,10 +484,12 @@ <h3>Public Instance Methods</h3>
</header>

<div id="method-i-where_assoc_count" class="method-detail ">
<div class="method-heading">
<span class="method-name">where_assoc_count</span><span
class="method-args">(left_operand, operator, association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">where_assoc_count</span><span
class="method-args">(left_operand, operator, association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand Down Expand Up @@ -588,7 +605,7 @@ <h3>Public Instance Methods</h3>

<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

44 changes: 26 additions & 18 deletions docs/ActiveRecordWhereAssoc/SqlReturningMethods.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h2>
<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"
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>

Expand Down Expand Up @@ -110,10 +110,12 @@ <h3>Public Instance Methods</h3>
</header>

<div id="method-i-assoc_exists_sql" class="method-detail ">
<div class="method-heading">
<span class="method-name">assoc_exists_sql</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">assoc_exists_sql</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand All @@ -140,10 +142,12 @@ <h3>Public Instance Methods</h3>
</div>

<div id="method-i-assoc_not_exists_sql" class="method-detail ">
<div class="method-heading">
<span class="method-name">assoc_not_exists_sql</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">assoc_not_exists_sql</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand All @@ -163,10 +167,12 @@ <h3>Public Instance Methods</h3>
</div>

<div id="method-i-compare_assoc_count_sql" class="method-detail ">
<div class="method-heading">
<span class="method-name">compare_assoc_count_sql</span><span
class="method-args">(left_operand, operator, association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">compare_assoc_count_sql</span><span
class="method-args">(left_operand, operator, association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand All @@ -193,10 +199,12 @@ <h3>Public Instance Methods</h3>
</div>

<div id="method-i-only_assoc_count_sql" class="method-detail ">
<div class="method-heading">
<span class="method-name">only_assoc_count_sql</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
<div class="method-header">
<div class="method-heading">
<span class="method-name">only_assoc_count_sql</span><span
class="method-args">(association_name, conditions = nil, options = {}, &amp;block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
</div>

<div class="method-description">
Expand Down Expand Up @@ -230,7 +238,7 @@ <h3>Public Instance Methods</h3>

<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

62 changes: 55 additions & 7 deletions docs/css/rdoc.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ body {
background: #fafafa;
font-family: Lato, sans-serif;
font-weight: 300;

/* Layout */
display: grid;
grid-template-columns: auto 1fr;
}

body > :last-child {
grid-column: 1 / 3;
}

h1 span,
Expand Down Expand Up @@ -79,6 +87,17 @@ pre {
border-radius: 0.2em;
}

em {
text-decoration-color: rgba(52, 48, 64, 0.25);
text-decoration-line: underline;
text-decoration-style: dotted;
}

strong,
em {
background-color: rgba(158, 178, 255, 0.1);
}

table {
margin: 0;
border-spacing: 0;
Expand Down Expand Up @@ -181,17 +200,25 @@ table tr:nth-child(even) td {
/* @group Top-Level Structure */

nav {
float: left;
width: 260px;
font-family: Helvetica, sans-serif;
font-size: 14px;
border-right: 1px solid #ccc;
position: sticky;
top: 0;
overflow: auto;

/* Layout */
width: 260px; /* fallback */
width: max(50px, 20vw);
min-width: 50px;
max-width: 80vw;
height: calc(100vh - 100px); /* reduce the footer height */
resize: horizontal;
}

main {
display: block;
margin: 0 2em 5em 260px;
padding-left: 20px;
margin: 1em;
min-width: 340px;
font-size: 16px;
}
Expand All @@ -210,7 +237,6 @@ main h6 {
}

#validator-badges {
clear: both;
margin: 1em 1em 2em;
font-size: smaller;
}
Expand Down Expand Up @@ -305,6 +331,28 @@ dl.note-list dt {
background: url(../images/arrow_up.png) no-repeat right center;
}

.nav-section details > summary {
display: block;
}

.nav-section details > summary::-webkit-details-marker {
display: none;
}

.nav-section details > summary::before {
content: "";
}

.nav-section details > summary::after {
content: "\25B6"; /* BLACK RIGHT-POINTING TRIANGLE */
font-size: 0.8em;
margin-left: 0.4em;
}

.nav-section details[open] > summary::after {
content: "\25BD"; /* WHITE DOWN-POINTING TRIANGLE */
}

/* @end */

/* @group Documentation Section */
Expand Down Expand Up @@ -482,7 +530,7 @@ main header h3 {

main .method-source-code {
max-height: 0;
overflow: hidden;
overflow: auto;
transition-duration: 200ms;
transition-delay: 0ms;
transition-property: all;
Expand Down Expand Up @@ -530,7 +578,7 @@ main .method-click-advice {
line-height: 20px;
background: url(../images/zoom.png) no-repeat right top;
}
main .method-heading:hover .method-click-advice {
main .method-header:hover .method-click-advice {
visibility: visible;
}

Expand Down
13 changes: 7 additions & 6 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ <h2>
<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"
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>

Expand All @@ -62,10 +62,11 @@ <h2>
<h3>Class and Module Index</h3>

<ul class="link-list">
<li><a href="./ActiveRecordWhereAssoc.html">ActiveRecordWhereAssoc</a>
<li><a href="./ActiveRecordWhereAssoc/RelationReturningMethods.html">ActiveRecordWhereAssoc::RelationReturningMethods</a>
<li><a href="./ActiveRecordWhereAssoc/SqlReturningMethods.html">ActiveRecordWhereAssoc::SqlReturningMethods</a>
</ul>
<li><details open><summary><code><a href="./ActiveRecordWhereAssoc.html">ActiveRecordWhereAssoc</a></code></summary>
<ul class="link-list">
<li><code><a href="./ActiveRecordWhereAssoc/RelationReturningMethods.html">RelationReturningMethods</a></code>
<li><code><a href="./ActiveRecordWhereAssoc/SqlReturningMethods.html">SqlReturningMethods</a></code>
</ul></details>
</div>

</div>
Expand All @@ -78,7 +79,7 @@ <h3>Class and Module Index</h3>

<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

15 changes: 14 additions & 1 deletion docs/js/darkfish.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ function hookSearch() {
var html = '';

// TODO add relative path to <script> per-page
html += '<p class="search-match"><a href="' + index_rel_prefix + result.path + '">' + this.hlt(result.title);
html += '<p class="search-match"><a href="' + index_rel_prefix + this.escapeHTML(result.path) + '">' + this.hlt(result.title);
if (result.params)
html += '<span class="params">' + result.params + '</span>';
html += '</a>';
Expand All @@ -78,7 +78,20 @@ function hookSearch() {
search.scrollIntoView = search.scrollInWindow;
};

function hookFocus() {
document.addEventListener("keydown", (event) => {
if (document.activeElement.tagName === 'INPUT') {
return;
}
if (event.key === "/") {
event.preventDefault();
document.querySelector('#search-field').focus();
}
});
}

document.addEventListener('DOMContentLoaded', function() {
hookSourceViews();
hookSearch();
hookFocus();
});
Loading

0 comments on commit 7402559

Please sign in to comment.