rdoc 6.15.0 → 7.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CONTRIBUTING.md +187 -0
- data/History.rdoc +1 -1
- data/LEGAL.rdoc +6 -0
- data/README.md +20 -3
- data/lib/rdoc/code_object/any_method.rb +15 -7
- data/lib/rdoc/code_object/class_module.rb +13 -0
- data/lib/rdoc/code_object/constant.rb +9 -0
- data/lib/rdoc/code_object/method_attr.rb +13 -1
- data/lib/rdoc/code_object/top_level.rb +31 -18
- data/lib/rdoc/comment.rb +190 -8
- data/lib/rdoc/generator/aliki.rb +183 -0
- data/lib/rdoc/generator/darkfish.rb +5 -1
- data/lib/rdoc/generator/template/aliki/_aside_toc.rhtml +8 -0
- data/lib/rdoc/generator/template/aliki/_footer.rhtml +23 -0
- data/lib/rdoc/generator/template/aliki/_head.rhtml +158 -0
- data/lib/rdoc/generator/template/aliki/_header.rhtml +56 -0
- data/lib/rdoc/generator/template/aliki/_icons.rhtml +208 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_ancestors.rhtml +16 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_classes.rhtml +15 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml +25 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml +25 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml +16 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_methods.rhtml +41 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml +67 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_search.rhtml +15 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml +21 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml +3 -0
- data/lib/rdoc/generator/template/aliki/class.rhtml +218 -0
- data/lib/rdoc/generator/template/aliki/css/rdoc.css +1944 -0
- data/lib/rdoc/generator/template/aliki/index.rhtml +22 -0
- data/lib/rdoc/generator/template/aliki/js/aliki.js +498 -0
- data/lib/rdoc/generator/template/aliki/js/c_highlighter.js +299 -0
- data/lib/rdoc/generator/template/aliki/js/search_controller.js +120 -0
- data/lib/rdoc/generator/template/aliki/js/search_navigation.js +105 -0
- data/lib/rdoc/generator/template/aliki/js/search_ranker.js +239 -0
- data/lib/rdoc/generator/template/aliki/js/theme-toggle.js +112 -0
- data/lib/rdoc/generator/template/aliki/page.rhtml +18 -0
- data/lib/rdoc/generator/template/aliki/servlet_not_found.rhtml +14 -0
- data/lib/rdoc/generator/template/aliki/servlet_root.rhtml +65 -0
- data/lib/rdoc/generator/template/darkfish/_footer.rhtml +3 -3
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +14 -19
- data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +8 -8
- data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +8 -8
- data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +7 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +6 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +19 -19
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +1 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +3 -3
- data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +14 -14
- data/lib/rdoc/generator/template/darkfish/class.rhtml +62 -62
- data/lib/rdoc/generator/template/darkfish/index.rhtml +4 -3
- data/lib/rdoc/generator/template/darkfish/page.rhtml +2 -1
- data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +2 -1
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +19 -19
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +19 -17
- data/lib/rdoc/generator/template/json_index/js/searcher.js +43 -6
- data/lib/rdoc/generator.rb +1 -0
- data/lib/rdoc/markup/pre_process.rb +34 -10
- data/lib/rdoc/markup/to_ansi.rb +4 -0
- data/lib/rdoc/markup/to_bs.rb +4 -0
- data/lib/rdoc/markup/to_html.rb +6 -4
- data/lib/rdoc/markup/to_rdoc.rb +11 -3
- data/lib/rdoc/options.rb +21 -10
- data/lib/rdoc/parser/c.rb +15 -46
- data/lib/rdoc/parser/prism_ruby.rb +121 -113
- data/lib/rdoc/parser/ruby.rb +8 -8
- data/lib/rdoc/parser/ruby_tools.rb +5 -7
- data/lib/rdoc/parser/simple.rb +4 -21
- data/lib/rdoc/rdoc.rb +1 -0
- data/lib/rdoc/rubygems_hook.rb +3 -3
- data/lib/rdoc/text.rb +1 -1
- data/lib/rdoc/token_stream.rb +13 -1
- data/lib/rdoc/tom_doc.rb +1 -1
- data/lib/rdoc/version.rb +1 -1
- data/rdoc.gemspec +1 -1
- metadata +33 -5
- data/CONTRIBUTING.rdoc +0 -219
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Aliki Search Implementation
|
|
3
|
+
*
|
|
4
|
+
* Search algorithm with the following priorities:
|
|
5
|
+
* 1. Exact full_name match always wins (for namespace/method queries)
|
|
6
|
+
* 2. Exact name match gets high priority
|
|
7
|
+
* 3. Match types:
|
|
8
|
+
* - Namespace queries (::) and method queries (# or .) match against full_name
|
|
9
|
+
* - Regular queries match against unqualified name
|
|
10
|
+
* - Prefix (10000) > substring (5000) > fuzzy (1000)
|
|
11
|
+
* 4. First character determines type priority:
|
|
12
|
+
* - Starts with lowercase: methods first
|
|
13
|
+
* - Starts with uppercase: classes/modules/constants first
|
|
14
|
+
* 5. Within same type priority:
|
|
15
|
+
* - Unqualified match > qualified match
|
|
16
|
+
* - Shorter name > longer name
|
|
17
|
+
* 6. Class methods > instance methods
|
|
18
|
+
* 7. Result limit: 30
|
|
19
|
+
* 8. Minimum query length: 1 character
|
|
20
|
+
*/
|
|
21
|
+
|
|
22
|
+
var MAX_RESULTS = 30;
|
|
23
|
+
var MIN_QUERY_LENGTH = 1;
|
|
24
|
+
|
|
25
|
+
/*
|
|
26
|
+
* Scoring constants - organized in tiers where each tier dominates lower tiers.
|
|
27
|
+
* This ensures match type always beats type priority, etc.
|
|
28
|
+
*
|
|
29
|
+
* Tier 0: Exact matches (immediate return)
|
|
30
|
+
* Tier 1: Match type (prefix > substring > fuzzy)
|
|
31
|
+
* Tier 2: Exact name bonus
|
|
32
|
+
* Tier 3: Type priority (method vs class based on query case)
|
|
33
|
+
* Tier 4: Minor bonuses (top-level, class method, name length)
|
|
34
|
+
*/
|
|
35
|
+
var SCORE_EXACT_FULL_NAME = 1000000; // Tier 0: Query exactly matches full_name
|
|
36
|
+
var SCORE_MATCH_PREFIX = 10000; // Tier 1: Query is prefix of name
|
|
37
|
+
var SCORE_MATCH_SUBSTRING = 5000; // Tier 1: Query is substring of name
|
|
38
|
+
var SCORE_MATCH_FUZZY = 1000; // Tier 1: Query chars appear in order
|
|
39
|
+
var SCORE_EXACT_NAME = 500; // Tier 2: Name exactly equals query
|
|
40
|
+
var SCORE_TYPE_PRIORITY = 100; // Tier 3: Preferred type (method/class)
|
|
41
|
+
var SCORE_TOP_LEVEL = 50; // Tier 4: Top-level over namespaced
|
|
42
|
+
var SCORE_CLASS_METHOD = 10; // Tier 4: Class method over instance method
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Check if all characters in query appear in order in target
|
|
46
|
+
* e.g., "addalias" fuzzy matches "add_foo_alias"
|
|
47
|
+
*/
|
|
48
|
+
function fuzzyMatch(target, query) {
|
|
49
|
+
var ti = 0;
|
|
50
|
+
for (var qi = 0; qi < query.length; qi++) {
|
|
51
|
+
ti = target.indexOf(query[qi], ti);
|
|
52
|
+
if (ti === -1) return false;
|
|
53
|
+
ti++;
|
|
54
|
+
}
|
|
55
|
+
return true;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Parse and normalize a search query
|
|
60
|
+
* @param {string} query - The raw search query
|
|
61
|
+
* @returns {Object} Parsed query with normalized form and flags
|
|
62
|
+
*/
|
|
63
|
+
function parseQuery(query) {
|
|
64
|
+
// Lowercase for case-insensitive matching (so "hash" finds both Hash class and #hash methods)
|
|
65
|
+
var normalized = query.toLowerCase();
|
|
66
|
+
var isNamespaceQuery = query.includes('::');
|
|
67
|
+
var isMethodQuery = query.includes('#') || query.includes('.');
|
|
68
|
+
|
|
69
|
+
// Normalize . to :: (RDoc uses :: for class methods in full_name)
|
|
70
|
+
if (query.includes('.')) {
|
|
71
|
+
normalized = normalized.replace(/\./g, '::');
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
return {
|
|
75
|
+
original: query,
|
|
76
|
+
normalized: normalized,
|
|
77
|
+
isNamespaceQuery: isNamespaceQuery,
|
|
78
|
+
isMethodQuery: isMethodQuery,
|
|
79
|
+
// Namespace and method queries match against full_name instead of name
|
|
80
|
+
matchesFullName: isNamespaceQuery || isMethodQuery,
|
|
81
|
+
// If query starts with lowercase, prioritize methods; otherwise prioritize classes/modules/constants
|
|
82
|
+
prioritizeMethod: !/^[A-Z]/.test(query)
|
|
83
|
+
};
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Main search function
|
|
88
|
+
* @param {string} query - The search query
|
|
89
|
+
* @param {Array} index - The search index to search in
|
|
90
|
+
* @returns {Array} Array of matching entries, sorted by relevance
|
|
91
|
+
*/
|
|
92
|
+
function search(query, index) {
|
|
93
|
+
if (!query || query.length < MIN_QUERY_LENGTH) {
|
|
94
|
+
return [];
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
var q = parseQuery(query);
|
|
98
|
+
var results = [];
|
|
99
|
+
|
|
100
|
+
for (var i = 0; i < index.length; i++) {
|
|
101
|
+
var entry = index[i];
|
|
102
|
+
var score = computeScore(entry, q);
|
|
103
|
+
|
|
104
|
+
if (score !== null) {
|
|
105
|
+
results.push({ entry: entry, score: score });
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
results.sort(function(a, b) {
|
|
110
|
+
return b.score - a.score;
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
return results.slice(0, MAX_RESULTS).map(function(r) {
|
|
114
|
+
return r.entry;
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Compute the relevance score for an entry
|
|
120
|
+
* @param {Object} entry - The search index entry
|
|
121
|
+
* @param {Object} q - Parsed query from parseQuery()
|
|
122
|
+
* @returns {number|null} Score or null if no match
|
|
123
|
+
*/
|
|
124
|
+
function computeScore(entry, q) {
|
|
125
|
+
var name = entry.name;
|
|
126
|
+
var fullName = entry.full_name;
|
|
127
|
+
var type = entry.type;
|
|
128
|
+
|
|
129
|
+
var nameLower = name.toLowerCase();
|
|
130
|
+
var fullNameLower = fullName.toLowerCase();
|
|
131
|
+
|
|
132
|
+
// Exact full_name match (e.g., "Array#filter" matches Array#filter)
|
|
133
|
+
if (q.matchesFullName && fullNameLower === q.normalized) {
|
|
134
|
+
return SCORE_EXACT_FULL_NAME;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
var matchScore = 0;
|
|
138
|
+
var target = q.matchesFullName ? fullNameLower : nameLower;
|
|
139
|
+
|
|
140
|
+
if (target.startsWith(q.normalized)) {
|
|
141
|
+
matchScore = SCORE_MATCH_PREFIX; // Prefix (e.g., "Arr" matches "Array")
|
|
142
|
+
} else if (target.includes(q.normalized)) {
|
|
143
|
+
matchScore = SCORE_MATCH_SUBSTRING; // Substring (e.g., "ray" matches "Array")
|
|
144
|
+
} else if (fuzzyMatch(target, q.normalized)) {
|
|
145
|
+
matchScore = SCORE_MATCH_FUZZY; // Fuzzy (e.g., "addalias" matches "add_foo_alias")
|
|
146
|
+
} else {
|
|
147
|
+
return null;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
var score = matchScore;
|
|
151
|
+
var isMethod = (type === 'instance_method' || type === 'class_method');
|
|
152
|
+
|
|
153
|
+
if (q.prioritizeMethod ? isMethod : !isMethod) {
|
|
154
|
+
score += SCORE_TYPE_PRIORITY;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
if (type === 'class_method') score += SCORE_CLASS_METHOD;
|
|
158
|
+
if (name === fullName) score += SCORE_TOP_LEVEL; // Top-level (Hash) > namespaced (Foo::Hash)
|
|
159
|
+
if (nameLower === q.normalized) score += SCORE_EXACT_NAME; // Exact name match
|
|
160
|
+
score -= name.length;
|
|
161
|
+
|
|
162
|
+
return score;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* SearchRanker class for compatibility with the Search UI
|
|
167
|
+
* Provides ready() and find() interface
|
|
168
|
+
*/
|
|
169
|
+
function SearchRanker(index) {
|
|
170
|
+
this.index = index;
|
|
171
|
+
this.handlers = [];
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
SearchRanker.prototype.ready = function(fn) {
|
|
175
|
+
this.handlers.push(fn);
|
|
176
|
+
};
|
|
177
|
+
|
|
178
|
+
SearchRanker.prototype.find = function(query) {
|
|
179
|
+
var q = parseQuery(query);
|
|
180
|
+
var rawResults = search(query, this.index);
|
|
181
|
+
var results = rawResults.map(function(entry) {
|
|
182
|
+
return formatResult(entry, q);
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
var _this = this;
|
|
186
|
+
this.handlers.forEach(function(fn) {
|
|
187
|
+
fn.call(_this, results, true);
|
|
188
|
+
});
|
|
189
|
+
};
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* Format a search result entry for display
|
|
193
|
+
*/
|
|
194
|
+
function formatResult(entry, q) {
|
|
195
|
+
var result = {
|
|
196
|
+
title: highlightMatch(entry.full_name, q),
|
|
197
|
+
path: entry.path,
|
|
198
|
+
type: entry.type
|
|
199
|
+
};
|
|
200
|
+
|
|
201
|
+
if (entry.snippet) {
|
|
202
|
+
result.snippet = entry.snippet;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
return result;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Add highlight markers (\u0001 and \u0002) to matching portions of text
|
|
210
|
+
* @param {string} text - The text to highlight
|
|
211
|
+
* @param {Object} q - Parsed query from parseQuery()
|
|
212
|
+
*/
|
|
213
|
+
function highlightMatch(text, q) {
|
|
214
|
+
if (!text || !q) return text;
|
|
215
|
+
|
|
216
|
+
var textLower = text.toLowerCase();
|
|
217
|
+
var query = q.normalized;
|
|
218
|
+
|
|
219
|
+
// Try contiguous match first (prefix or substring)
|
|
220
|
+
var matchIndex = textLower.indexOf(query);
|
|
221
|
+
if (matchIndex !== -1) {
|
|
222
|
+
return text.substring(0, matchIndex) +
|
|
223
|
+
'\u0001' + text.substring(matchIndex, matchIndex + query.length) + '\u0002' +
|
|
224
|
+
text.substring(matchIndex + query.length);
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
// Fall back to fuzzy highlight (highlight each matched character)
|
|
228
|
+
var result = '';
|
|
229
|
+
var ti = 0;
|
|
230
|
+
for (var qi = 0; qi < query.length; qi++) {
|
|
231
|
+
var charIndex = textLower.indexOf(query[qi], ti);
|
|
232
|
+
if (charIndex === -1) return text;
|
|
233
|
+
result += text.substring(ti, charIndex);
|
|
234
|
+
result += '\u0001' + text[charIndex] + '\u0002';
|
|
235
|
+
ti = charIndex + 1;
|
|
236
|
+
}
|
|
237
|
+
result += text.substring(ti);
|
|
238
|
+
return result;
|
|
239
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
(function() {
|
|
2
|
+
'use strict';
|
|
3
|
+
|
|
4
|
+
const STORAGE_KEY = 'rdoc-theme';
|
|
5
|
+
const THEME_LIGHT = 'light';
|
|
6
|
+
const THEME_DARK = 'dark';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Get the user's theme preference
|
|
10
|
+
* Priority: localStorage > system preference > light (default)
|
|
11
|
+
*/
|
|
12
|
+
function getThemePreference() {
|
|
13
|
+
// Check localStorage first
|
|
14
|
+
const stored = localStorage.getItem(STORAGE_KEY);
|
|
15
|
+
if (stored === THEME_LIGHT || stored === THEME_DARK) {
|
|
16
|
+
return stored;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
// Check system preference
|
|
20
|
+
if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
|
|
21
|
+
return THEME_DARK;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
return THEME_LIGHT;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Apply theme to document
|
|
29
|
+
*/
|
|
30
|
+
function applyTheme(theme) {
|
|
31
|
+
document.documentElement.setAttribute('data-theme', theme);
|
|
32
|
+
localStorage.setItem(STORAGE_KEY, theme);
|
|
33
|
+
|
|
34
|
+
// Update toggle button icon
|
|
35
|
+
const toggleBtn = document.getElementById('theme-toggle');
|
|
36
|
+
if (toggleBtn) {
|
|
37
|
+
const icon = toggleBtn.querySelector('.theme-toggle-icon');
|
|
38
|
+
if (icon) {
|
|
39
|
+
icon.textContent = theme === THEME_DARK ? '☀️' : '🌙';
|
|
40
|
+
}
|
|
41
|
+
toggleBtn.setAttribute('aria-label',
|
|
42
|
+
theme === THEME_DARK ? 'Switch to light mode' : 'Switch to dark mode'
|
|
43
|
+
);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Toggle between light and dark themes
|
|
49
|
+
*/
|
|
50
|
+
function toggleTheme() {
|
|
51
|
+
const currentTheme = document.documentElement.getAttribute('data-theme') || THEME_LIGHT;
|
|
52
|
+
const newTheme = currentTheme === THEME_LIGHT ? THEME_DARK : THEME_LIGHT;
|
|
53
|
+
applyTheme(newTheme);
|
|
54
|
+
|
|
55
|
+
// Announce to screen readers
|
|
56
|
+
announceThemeChange(newTheme);
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* Announce theme change to screen readers
|
|
61
|
+
*/
|
|
62
|
+
function announceThemeChange(theme) {
|
|
63
|
+
const announcement = document.createElement('div');
|
|
64
|
+
announcement.setAttribute('role', 'status');
|
|
65
|
+
announcement.setAttribute('aria-live', 'polite');
|
|
66
|
+
announcement.className = 'sr-only';
|
|
67
|
+
announcement.textContent = `Switched to ${theme} mode`;
|
|
68
|
+
document.body.appendChild(announcement);
|
|
69
|
+
|
|
70
|
+
// Remove after announcement
|
|
71
|
+
setTimeout(() => {
|
|
72
|
+
document.body.removeChild(announcement);
|
|
73
|
+
}, 1000);
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Initialize theme on page load
|
|
78
|
+
*/
|
|
79
|
+
function initTheme() {
|
|
80
|
+
// Apply theme immediately to prevent flash
|
|
81
|
+
const theme = getThemePreference();
|
|
82
|
+
applyTheme(theme);
|
|
83
|
+
|
|
84
|
+
// Set up toggle button listener
|
|
85
|
+
const toggleBtn = document.getElementById('theme-toggle');
|
|
86
|
+
if (toggleBtn) {
|
|
87
|
+
toggleBtn.addEventListener('click', toggleTheme);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
// Listen for system theme changes
|
|
91
|
+
if (window.matchMedia) {
|
|
92
|
+
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', (e) => {
|
|
93
|
+
// Only auto-switch if user hasn't manually set a preference
|
|
94
|
+
const stored = localStorage.getItem(STORAGE_KEY);
|
|
95
|
+
if (!stored) {
|
|
96
|
+
applyTheme(e.matches ? THEME_DARK : THEME_LIGHT);
|
|
97
|
+
}
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
// Initialize immediately (before DOMContentLoaded to prevent flash)
|
|
103
|
+
if (document.readyState === 'loading') {
|
|
104
|
+
// Apply theme as early as possible
|
|
105
|
+
const theme = getThemePreference();
|
|
106
|
+
document.documentElement.setAttribute('data-theme', theme);
|
|
107
|
+
|
|
108
|
+
document.addEventListener('DOMContentLoaded', initTheme);
|
|
109
|
+
} else {
|
|
110
|
+
initTheme();
|
|
111
|
+
}
|
|
112
|
+
})();
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<body role="document" class="file has-toc">
|
|
2
|
+
<%= render '_icons.rhtml' %>
|
|
3
|
+
<%= render '_header.rhtml' %>
|
|
4
|
+
<%= render '_sidebar_toggle.rhtml' %>
|
|
5
|
+
|
|
6
|
+
<nav id="navigation" role="navigation">
|
|
7
|
+
<%= render '_sidebar_pages.rhtml' %>
|
|
8
|
+
<%= render '_sidebar_classes.rhtml' %>
|
|
9
|
+
</nav>
|
|
10
|
+
|
|
11
|
+
<main role="main" aria-label="Page <%= h file.full_name %>">
|
|
12
|
+
<%= file.description %>
|
|
13
|
+
</main>
|
|
14
|
+
|
|
15
|
+
<%= render '_aside_toc.rhtml' %>
|
|
16
|
+
|
|
17
|
+
<%= render '_footer.rhtml' %>
|
|
18
|
+
</body>
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
<body role="document">
|
|
2
|
+
<%= render '_sidebar_toggle.rhtml' %>
|
|
3
|
+
|
|
4
|
+
<nav id="navigation" role="navigation">
|
|
5
|
+
<%= render '_sidebar_pages.rhtml' %>
|
|
6
|
+
<%= render '_sidebar_classes.rhtml' %>
|
|
7
|
+
</nav>
|
|
8
|
+
|
|
9
|
+
<main role="main">
|
|
10
|
+
<h1>Not Found</h1>
|
|
11
|
+
|
|
12
|
+
<p><%= message %></p>
|
|
13
|
+
</main>
|
|
14
|
+
</body>
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
<body role="document">
|
|
2
|
+
<%= render '_sidebar_toggle.rhtml' %>
|
|
3
|
+
|
|
4
|
+
<nav id="navigation" role="navigation">
|
|
5
|
+
<div id="project-navigation">
|
|
6
|
+
<div id="home-section" class="nav-section">
|
|
7
|
+
<h2>
|
|
8
|
+
<a href="<%= rel_prefix %>/" rel="home">Home</a>
|
|
9
|
+
</h2>
|
|
10
|
+
</div>
|
|
11
|
+
|
|
12
|
+
<%= render '_sidebar_search.rhtml' %>
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
<%= render '_sidebar_installed.rhtml' %>
|
|
16
|
+
</nav>
|
|
17
|
+
|
|
18
|
+
<main role="main">
|
|
19
|
+
<h1>Local RDoc Documentation</h1>
|
|
20
|
+
|
|
21
|
+
<p>Here you can browse local documentation from the ruby standard library and
|
|
22
|
+
your installed gems.</p>
|
|
23
|
+
|
|
24
|
+
<%- extra_dirs = installed.select { |_, _, _, type,| type == :extra } %>
|
|
25
|
+
<%- unless extra_dirs.empty? %>
|
|
26
|
+
<h2>Extra Documentation Directories</h2>
|
|
27
|
+
|
|
28
|
+
<p>The following additional documentation directories are available:</p>
|
|
29
|
+
|
|
30
|
+
<ol>
|
|
31
|
+
<%- extra_dirs.each do |name, href, exists, _, path| %>
|
|
32
|
+
<li>
|
|
33
|
+
<%- if exists %>
|
|
34
|
+
<a href="<%= href %>"><%= h name %></a> (<%= h path %>)
|
|
35
|
+
<%- else %>
|
|
36
|
+
<%= h name %> (<%= h path %>; <i>not available</i>)
|
|
37
|
+
<%- end %>
|
|
38
|
+
</li>
|
|
39
|
+
<%- end %>
|
|
40
|
+
</ol>
|
|
41
|
+
<%- end %>
|
|
42
|
+
|
|
43
|
+
<%- gems = installed.select { |_, _, _, type,| type == :gem } %>
|
|
44
|
+
<%- missing = gems.reject { |_, _, exists,| exists } %>
|
|
45
|
+
<%- unless missing.empty? then %>
|
|
46
|
+
<h2>Missing Gem Documentation</h2>
|
|
47
|
+
|
|
48
|
+
<p>You are missing documentation for some of your installed gems.
|
|
49
|
+
You can install missing documentation for gems by running
|
|
50
|
+
<kbd>gem rdoc --all</kbd>. After installing the missing documentation you
|
|
51
|
+
only need to reload this page. The newly created documentation will
|
|
52
|
+
automatically appear.</p>
|
|
53
|
+
|
|
54
|
+
<p>You can also install documentation for a specific gem by running one of
|
|
55
|
+
the following commands.</p>
|
|
56
|
+
|
|
57
|
+
<ul>
|
|
58
|
+
<%- names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq %>
|
|
59
|
+
<%- names.each do |name| %>
|
|
60
|
+
<li><kbd>gem rdoc <%= h name %></kbd></li>
|
|
61
|
+
<%- end %>
|
|
62
|
+
</ul>
|
|
63
|
+
<%- end %>
|
|
64
|
+
</main>
|
|
65
|
+
</body>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<footer id="validator-badges" role="contentinfo">
|
|
2
|
-
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
3
|
-
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> <%= RDoc::VERSION
|
|
4
|
-
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a
|
|
2
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
|
|
3
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> <%= RDoc::VERSION %>.</p>
|
|
4
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>
|
|
5
5
|
</footer>
|
|
@@ -1,34 +1,29 @@
|
|
|
1
1
|
<meta charset="<%= @options.charset %>">
|
|
2
|
-
<meta name="viewport" content="width=device-width, initial-scale=1"
|
|
2
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
3
3
|
|
|
4
4
|
<title><%= h @title %></title>
|
|
5
5
|
|
|
6
|
-
<%- if defined?(klass)
|
|
6
|
+
<%- if defined?(klass) %>
|
|
7
7
|
<meta name="keywords" content="ruby,<%= h "#{klass.type},#{klass.full_name}" %>">
|
|
8
8
|
|
|
9
|
-
<%- if klass.comment.empty?
|
|
9
|
+
<%- if klass.comment.empty? %>
|
|
10
10
|
<meta name="description" content="Documentation for the <%= h "#{klass.full_name} #{klass.type}" %>">
|
|
11
|
-
<%- else
|
|
11
|
+
<%- else %>
|
|
12
12
|
<meta name="description" content="<%= h "#{klass.type} #{klass.full_name}: #{excerpt(klass.comment)}" %>">
|
|
13
|
-
<%- end
|
|
14
|
-
<%- elsif defined?(file)
|
|
13
|
+
<%- end %>
|
|
14
|
+
<%- elsif defined?(file) %>
|
|
15
15
|
<meta name="keywords" content="ruby,documentation,<%= h file.page_name %>">
|
|
16
16
|
<meta name="description" content="<%= h "#{file.page_name}: #{excerpt(file.comment)}" %>">
|
|
17
|
-
<%- elsif @title
|
|
17
|
+
<%- elsif @title %>
|
|
18
18
|
<meta name="keywords" content="ruby,documentation,<%= h @title %>">
|
|
19
|
+
<% description = @main_page ? "#{@title}: #{excerpt(@main_page.comment)}" : "Documentation for #{@title}" %>
|
|
20
|
+
<meta name="description" content="<%= h description %>">
|
|
21
|
+
<%- end %>
|
|
19
22
|
|
|
20
|
-
|
|
21
|
-
main_page = @files.find { |f| f.full_name == @options.main_page } then %>
|
|
22
|
-
<meta name="description" content="<%= h "#{@title}: #{excerpt(main_page.comment)}" %>">
|
|
23
|
-
<%- else -%>
|
|
24
|
-
<meta name="description" content="Documentation for <%= h @title %>">
|
|
25
|
-
<%- end -%>
|
|
26
|
-
<%- end -%>
|
|
27
|
-
|
|
28
|
-
<%- if canonical_url = @options.canonical_root -%>
|
|
23
|
+
<%- if canonical_url = @options.canonical_root %>
|
|
29
24
|
<% canonical_url = current.canonical_url if defined?(current) %>
|
|
30
25
|
<link rel="canonical" href="<%= canonical_url %>">
|
|
31
|
-
<%- end
|
|
26
|
+
<%- end %>
|
|
32
27
|
|
|
33
28
|
<script type="text/javascript">
|
|
34
29
|
var rdoc_rel_prefix = "<%= h asset_rel_prefix %>/";
|
|
@@ -43,6 +38,6 @@
|
|
|
43
38
|
|
|
44
39
|
<link href="<%= h asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
|
|
45
40
|
<link href="<%= h asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
|
|
46
|
-
<%- @options.template_stylesheets.each do |stylesheet|
|
|
41
|
+
<%- @options.template_stylesheets.each do |stylesheet| %>
|
|
47
42
|
<link href="<%= h asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
|
|
48
|
-
<%- end
|
|
43
|
+
<%- end %>
|
|
@@ -3,13 +3,13 @@
|
|
|
3
3
|
<h3>Extended With Modules</h3>
|
|
4
4
|
|
|
5
5
|
<ul class="link-list">
|
|
6
|
-
|
|
7
|
-
<%- unless String === ext.module then
|
|
8
|
-
<li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
|
|
9
|
-
<%- else
|
|
10
|
-
<li><span class="extend"><%= ext.name %></span>
|
|
11
|
-
<%- end
|
|
12
|
-
<%- end
|
|
6
|
+
<%- klass.extends.each do |ext| %>
|
|
7
|
+
<%- unless String === ext.module then %>
|
|
8
|
+
<li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a></li>
|
|
9
|
+
<%- else %>
|
|
10
|
+
<li><span class="extend"><%= ext.name %></span></li>
|
|
11
|
+
<%- end %>
|
|
12
|
+
<%- end %>
|
|
13
13
|
</ul>
|
|
14
14
|
</div>
|
|
15
|
-
<%- end
|
|
15
|
+
<%- end %>
|
|
@@ -3,13 +3,13 @@
|
|
|
3
3
|
<h3>Included Modules</h3>
|
|
4
4
|
|
|
5
5
|
<ul class="link-list">
|
|
6
|
-
<%- klass.includes.each do |inc|
|
|
7
|
-
<%- unless String === inc.module then
|
|
8
|
-
<li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
|
|
9
|
-
<%- else
|
|
10
|
-
<li><span class="include"><%= inc.name %></span>
|
|
11
|
-
<%- end
|
|
12
|
-
<%- end
|
|
6
|
+
<%- klass.includes.each do |inc| %>
|
|
7
|
+
<%- unless String === inc.module then %>
|
|
8
|
+
<li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
|
|
9
|
+
<%- else %>
|
|
10
|
+
<li><span class="include"><%= inc.name %></span></li>
|
|
11
|
+
<%- end %>
|
|
12
|
+
<%- end %>
|
|
13
13
|
</ul>
|
|
14
14
|
</div>
|
|
15
|
-
<%- end
|
|
15
|
+
<%- end %>
|
|
@@ -2,14 +2,15 @@
|
|
|
2
2
|
<h3>Documentation</h3>
|
|
3
3
|
|
|
4
4
|
<ul>
|
|
5
|
-
<%- installed.each do |name, href, exists, type, _|
|
|
6
|
-
<%- next if type == :extra
|
|
5
|
+
<%- installed.each do |name, href, exists, type, _| %>
|
|
6
|
+
<%- next if type == :extra %>
|
|
7
7
|
<li class="folder">
|
|
8
|
-
<%- if exists then
|
|
8
|
+
<%- if exists then %>
|
|
9
9
|
<a href="<%= href %>"><%= h name %></a>
|
|
10
|
-
<%- else
|
|
10
|
+
<%- else %>
|
|
11
11
|
<%= h name %>
|
|
12
|
-
<%- end
|
|
13
|
-
|
|
12
|
+
<%- end %>
|
|
13
|
+
</li>
|
|
14
|
+
<%- end %>
|
|
14
15
|
</ul>
|
|
15
16
|
</div>
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
<div class="nav-section">
|
|
3
3
|
<h3>Class Methods</h3>
|
|
4
4
|
<ul class="link-list" role="directory">
|
|
5
|
-
<%- class_methods.each do |meth|
|
|
6
|
-
<li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name
|
|
7
|
-
<%- end
|
|
5
|
+
<%- class_methods.each do |meth| %>
|
|
6
|
+
<li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name %></a></li>
|
|
7
|
+
<%- end %>
|
|
8
8
|
</ul>
|
|
9
9
|
</div>
|
|
10
10
|
<% end %>
|
|
@@ -13,9 +13,9 @@
|
|
|
13
13
|
<div class="nav-section">
|
|
14
14
|
<h3>Instance Methods</h3>
|
|
15
15
|
<ul class="link-list" role="directory">
|
|
16
|
-
<%- instance_methods.each do |meth|
|
|
17
|
-
<li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name
|
|
18
|
-
<%- end
|
|
16
|
+
<%- instance_methods.each do |meth| %>
|
|
17
|
+
<li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name %></a></li>
|
|
18
|
+
<%- end %>
|
|
19
19
|
</ul>
|
|
20
20
|
</div>
|
|
21
21
|
<% end %>
|
|
@@ -1,32 +1,32 @@
|
|
|
1
1
|
<%- simple_files = @files.select { |f| f.text? } %>
|
|
2
|
-
<%- if defined?(current)
|
|
3
|
-
<%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name
|
|
4
|
-
<%- end
|
|
5
|
-
<%- unless simple_files.empty? then
|
|
2
|
+
<%- if defined?(current) %>
|
|
3
|
+
<%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name %>
|
|
4
|
+
<%- end %>
|
|
5
|
+
<%- unless simple_files.empty? then %>
|
|
6
6
|
<div id="fileindex-section" class="nav-section">
|
|
7
7
|
<h3>Pages</h3>
|
|
8
8
|
|
|
9
9
|
<ul class="link-list">
|
|
10
|
-
<%- simple_files.group_by do |f|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
<%- f = files.shift
|
|
14
|
-
<%- if files.empty?
|
|
15
|
-
<li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
|
|
16
|
-
<%- next
|
|
17
|
-
<%- end
|
|
18
|
-
<li><details
|
|
10
|
+
<%- simple_files.group_by do |f|
|
|
11
|
+
f.full_name[%r{\A[^/]+(?=/)}] || f.page_name
|
|
12
|
+
end.each do |n, files| %>
|
|
13
|
+
<%- f = files.shift %>
|
|
14
|
+
<%- if files.empty? %>
|
|
15
|
+
<li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a></li>
|
|
16
|
+
<%- next %>
|
|
17
|
+
<%- end %>
|
|
18
|
+
<li><details<%= ' open' if dir == n %>><summary><%
|
|
19
19
|
if n == f.page_name
|
|
20
20
|
%><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h n %></a><%
|
|
21
21
|
else
|
|
22
22
|
%><%= h n %><% files.unshift(f)
|
|
23
23
|
end %></summary>
|
|
24
24
|
<ul class="link-list">
|
|
25
|
-
<%- files.each do |f|
|
|
26
|
-
<li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
|
|
27
|
-
<%- end
|
|
28
|
-
</ul></details>
|
|
29
|
-
<%- end
|
|
25
|
+
<%- files.each do |f| %>
|
|
26
|
+
<li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a></li>
|
|
27
|
+
<%- end %>
|
|
28
|
+
</ul></details></li>
|
|
29
|
+
<%- end %>
|
|
30
30
|
</ul>
|
|
31
31
|
</div>
|
|
32
|
-
<%- end
|
|
32
|
+
<%- end %>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<%- if klass.type == 'class' && (ancestors = klass.super_classes).any?
|
|
1
|
+
<%- if klass.type == 'class' && (ancestors = klass.super_classes).any? %>
|
|
2
2
|
<div id="parent-class-section" class="nav-section">
|
|
3
3
|
<h3>Ancestors</h3>
|
|
4
4
|
<%= generate_ancestor_list(ancestors, klass) %>
|
|
5
5
|
</div>
|
|
6
|
-
<%- end
|
|
6
|
+
<%- end %>
|