rdoc-generator-sixfish 0.1.0 → 0.2.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
- checksums.yaml.gz.sig +0 -0
- data/History.md +13 -0
- data/data/rdoc-generator-sixfish/templates/layout.tmpl +1 -1
- data/lib/rdoc/generator/sixfish.rb +1 -34
- data/lib/sixfish.rb +1 -1
- data.tar.gz.sig +0 -0
- metadata +2 -2
- metadata.gz.sig +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1e00d9832292983218c97547089985e4d4ba9640b4416b40dfaaf8f9e578209a
|
|
4
|
+
data.tar.gz: 28ddad906b580bfdbcef19260a8ac4bcfdede5661702b57e9dd390ace7e660b7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 012d0f199ccf17a16e369bb2174845053fb420a26851d42d2f7e2405b90e6a4af003274ae8a98f888141b646b8f6fd726258f0dfd310199fa006e723f792b03a
|
|
7
|
+
data.tar.gz: 1cd26073c927a84a9e8d6372254dd7d707eb15fd8c1dba464a6e287a61ddd0cbc4c291e4752ff323d348d8de308fde5006dfeaf254ea31dd0efec37c68433ca5
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/History.md
CHANGED
|
@@ -2,6 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
+
## v0.2.1 [2022-12-22] Michael Granger <ged@faeriemud.org>
|
|
6
|
+
|
|
7
|
+
Bugfixes:
|
|
8
|
+
|
|
9
|
+
- Fix method links for child classes; thanks to Mahlon E. Smith for the patch.
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## v0.2.0 [2022-12-01] Michael Granger <ged@faeriemud.org>
|
|
13
|
+
|
|
14
|
+
Fixes:
|
|
15
|
+
|
|
16
|
+
- Remove unused code and dependencies
|
|
17
|
+
|
|
5
18
|
|
|
6
19
|
## v0.1.0 [2022-11-15] Michael Granger <ged@FaerieMUD.org>
|
|
7
20
|
|
|
@@ -68,7 +68,7 @@
|
|
|
68
68
|
<?for method in methods.uniq {|m| m.path } ?>
|
|
69
69
|
<li class="method" data-search-term="[?attr method.name ?]"><a
|
|
70
70
|
title="[?call method.parent.full_name ?]"
|
|
71
|
-
href="[?call method.path ?]"><?call method.pretty_name ?>
|
|
71
|
+
href="[?attr rel_prefix ?]/[?call method.path ?]"><?call method.pretty_name ?>
|
|
72
72
|
<span class="method-parent">[<?call
|
|
73
73
|
method.parent.full_name.sub(/.*(::)/, '\\1') ?>]</span>
|
|
74
74
|
</a>
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
gem 'rdoc'
|
|
4
4
|
|
|
5
5
|
require 'uri'
|
|
6
|
-
require 'yajl'
|
|
7
6
|
require 'inversion'
|
|
8
7
|
require 'loggability'
|
|
9
8
|
require 'fileutils'
|
|
@@ -32,7 +31,7 @@ class RDoc::Generator::Sixfish
|
|
|
32
31
|
File.exist?( Gem.loaded_specs['rdoc-generator-sixfish'].datadir )
|
|
33
32
|
Pathname( Gem.loaded_specs['rdoc-generator-sixfish'].datadir )
|
|
34
33
|
else
|
|
35
|
-
Pathname( __FILE__ ).dirname.parent + 'data/rdoc-generator-sixfish'
|
|
34
|
+
Pathname( __FILE__ ).dirname.parent.parent.parent + 'data/rdoc-generator-sixfish'
|
|
36
35
|
end
|
|
37
36
|
|
|
38
37
|
# Register with RDoc as an alternative generator
|
|
@@ -75,7 +74,6 @@ class RDoc::Generator::Sixfish
|
|
|
75
74
|
@template_cache = {}
|
|
76
75
|
@files = nil
|
|
77
76
|
@classes = nil
|
|
78
|
-
@search_index = {}
|
|
79
77
|
|
|
80
78
|
Inversion::Template.configure( :template_paths => [self.template_dir + 'templates'] )
|
|
81
79
|
end
|
|
@@ -130,8 +128,6 @@ class RDoc::Generator::Sixfish
|
|
|
130
128
|
self.generate_class_files
|
|
131
129
|
self.generate_file_files
|
|
132
130
|
|
|
133
|
-
self.generate_search_index
|
|
134
|
-
|
|
135
131
|
self.copy_static_assets
|
|
136
132
|
end
|
|
137
133
|
|
|
@@ -220,35 +216,6 @@ class RDoc::Generator::Sixfish
|
|
|
220
216
|
end
|
|
221
217
|
|
|
222
218
|
|
|
223
|
-
### Generate a JSON search index for the quicksearch blank.
|
|
224
|
-
def generate_search_index
|
|
225
|
-
out_file = self.output_dir + 'js/searchindex.json'
|
|
226
|
-
|
|
227
|
-
self.log.debug "Generating search index (%s)." % [ out_file ]
|
|
228
|
-
index = []
|
|
229
|
-
|
|
230
|
-
objs = self.get_indexable_objects
|
|
231
|
-
objs.each do |codeobj|
|
|
232
|
-
self.log.debug " #{codeobj.name}..."
|
|
233
|
-
record = codeobj.search_record
|
|
234
|
-
index << {
|
|
235
|
-
name: record[2],
|
|
236
|
-
link: record[4],
|
|
237
|
-
snippet: record[6],
|
|
238
|
-
type: codeobj.class.name.downcase.sub( /.*::/, '' )
|
|
239
|
-
}
|
|
240
|
-
end
|
|
241
|
-
|
|
242
|
-
self.log.debug " dumping JSON..."
|
|
243
|
-
out_file.dirname.mkpath
|
|
244
|
-
ofh = out_file.open( 'w:utf-8', 0644 )
|
|
245
|
-
|
|
246
|
-
json = Yajl.dump( index, pretty: true, indent: "\t" )
|
|
247
|
-
|
|
248
|
-
ofh.puts( 'var SearchIndex = ', json, ';' )
|
|
249
|
-
end
|
|
250
|
-
|
|
251
|
-
|
|
252
219
|
### Copies static files from the static_path into the output directory
|
|
253
220
|
def copy_static_assets
|
|
254
221
|
asset_paths = self.find_static_assets
|
data/lib/sixfish.rb
CHANGED
data.tar.gz.sig
CHANGED
|
Binary file
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: rdoc-generator-sixfish
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1
|
|
4
|
+
version: 0.2.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Michael Granger
|
|
@@ -33,7 +33,7 @@ cert_chain:
|
|
|
33
33
|
P5YP5BAbNW+gvd3QHRiWTTuhgHrdDnGdXg93N2M5KHn1ug8BtPLQwlcFwEpKnlLn
|
|
34
34
|
btEP+7EplFuoiMfd
|
|
35
35
|
-----END CERTIFICATE-----
|
|
36
|
-
date: 2022-
|
|
36
|
+
date: 2022-12-22 00:00:00.000000000 Z
|
|
37
37
|
dependencies:
|
|
38
38
|
- !ruby/object:Gem::Dependency
|
|
39
39
|
name: inversion
|
metadata.gz.sig
CHANGED
|
Binary file
|