darkfish-rdoc 1.1.3 → 1.1.4
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.
- data/ChangeLog +20 -0
- data/README +3 -3
- data/Rakefile +1 -1
- data/Rakefile.local +17 -0
- data/lib/darkfish-rdoc.rb +0 -3
- data/lib/rdoc/generator/darkfish.rb +2 -2
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +12 -1
- data/lib/rdoc/generator/template/darkfish/rdoc.css +14 -6
- data/rake/publishing.rb +1 -1
- metadata +2 -2
data/ChangeLog
CHANGED
@@ -1,3 +1,23 @@
|
|
1
|
+
-- Wed, 20 Aug 2008 01:28:01 -0000 by deveiant (r30) -----
|
2
|
+
Changed: Rakefile
|
3
|
+
project.yml
|
4
|
+
lib/rdoc/generator/template/darkfish/rdoc.css
|
5
|
+
lib/rdoc/generator/template/darkfish/js/darkfish.js
|
6
|
+
|
7
|
+
* Updated build system
|
8
|
+
* Added a fix for javascript 'console is not defined' bug in the darkfish.js file.
|
9
|
+
* Fixed the mushed-together method description when it has multiple paragraphs and/or definition
|
10
|
+
lists.
|
11
|
+
|
12
|
+
|
13
|
+
-- Tue, 19 Aug 2008 02:37:00 -0000 by deveiant (r29) -----
|
14
|
+
Changed: README
|
15
|
+
ChangeLog
|
16
|
+
Rakefile.local
|
17
|
+
|
18
|
+
Added some local tasks to clean up .svn directories before publication.
|
19
|
+
|
20
|
+
|
1
21
|
-- Tue, 19 Aug 2008 02:12:27 -0000 by deveiant (r27) -----
|
2
22
|
Changed: lib/rdoc/generator/darkfish.rb
|
3
23
|
lib/darkfish-rdoc.rb
|
data/README
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
= Darkfish Rdoc Generator
|
2
2
|
|
3
|
-
This is a complete replacement for the default HTML generator for Rdoc.
|
3
|
+
This is a complete replacement for the default HTML generator for Rdoc 2.
|
4
4
|
|
5
5
|
I created it with a few goals in mind:
|
6
6
|
|
@@ -12,7 +12,7 @@ I created it with a few goals in mind:
|
|
12
12
|
for modern browsers.
|
13
13
|
|
14
14
|
* Add some of the nifty searching and index-on-the-side stuff I liked from the
|
15
|
-
modified Allison template (
|
15
|
+
modified Allison template (http://www.superalloy.nl/blog/?p=7) Eloy
|
16
16
|
Duran came up with.
|
17
17
|
|
18
18
|
* Implemented using separate ERB template files instead of Rdoc's
|
@@ -74,7 +74,7 @@ That's it.
|
|
74
74
|
|
75
75
|
== Feedback
|
76
76
|
|
77
|
-
I'd be happy to have feedback via email
|
77
|
+
I'd be happy to have feedback via email (ged at FaerieMUD dot org)
|
78
78
|
or a ticket on the project's Trac:
|
79
79
|
|
80
80
|
http://deveiate.org/projects/Darkfish-Rdoc/
|
data/Rakefile
CHANGED
@@ -41,7 +41,7 @@ PKGDIR = BASEDIR + 'pkg'
|
|
41
41
|
|
42
42
|
PKG_NAME = 'darkfish-rdoc'
|
43
43
|
PKG_SUMMARY = 'A pretty (different) Rdoc HTML generator'
|
44
|
-
VERSION_FILE = LIBDIR + 'darkfish
|
44
|
+
VERSION_FILE = LIBDIR + 'rdoc/generator/darkfish.rb'
|
45
45
|
PKG_VERSION = VERSION_FILE.read[ /VERSION = '(\d+\.\d+\.\d+)'/, 1 ]
|
46
46
|
PKG_FILE_NAME = "#{PKG_NAME.downcase}-#{PKG_VERSION}"
|
47
47
|
GEM_FILE_NAME = "#{PKG_FILE_NAME}.gem"
|
data/Rakefile.local
CHANGED
@@ -1,4 +1,21 @@
|
|
1
1
|
|
2
|
+
task :debug do
|
3
|
+
$DEBUG = true
|
4
|
+
end
|
5
|
+
|
2
6
|
task :coverage do
|
3
7
|
trace "No coverage generated"
|
4
8
|
end
|
9
|
+
|
10
|
+
namespace :release do
|
11
|
+
task :project => [ :cleanup_rdoc_output ]
|
12
|
+
|
13
|
+
# Need to clean up .svn directories under the Rdoc output before publishing
|
14
|
+
task :cleanup_rdoc_output do
|
15
|
+
outputdir = DOCSDIR + 'html'
|
16
|
+
Pathname.glob( outputdir + '**/.svn' ).each do |pn|
|
17
|
+
rm_rf pn, :verbose => true, :noop => $DEBUG
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
data/lib/darkfish-rdoc.rb
CHANGED
@@ -7,9 +7,6 @@ gem 'rdoc', '>= 2.0.0'
|
|
7
7
|
require 'pathname'
|
8
8
|
require 'rdoc/rdoc' unless defined?( RDoc ) && defined?( RDoc::RDoc )
|
9
9
|
|
10
|
-
### Version for the Rakefile (update this in rdoc/generator/darkfish.rb too)
|
11
|
-
# VERSION = '1.1.3'
|
12
|
-
|
13
10
|
begin
|
14
11
|
generator_dir = Pathname.new( __FILE__ ).dirname + 'rdoc/generator'
|
15
12
|
|
@@ -57,8 +57,8 @@ class RDoc::Generator::Darkfish < RDoc::Generator::XML
|
|
57
57
|
# resources.
|
58
58
|
GENERATOR_DIR = Pathname.new( __FILE__ ).expand_path.dirname
|
59
59
|
|
60
|
-
#
|
61
|
-
VERSION = '1.1.
|
60
|
+
# Release Version
|
61
|
+
VERSION = '1.1.4'
|
62
62
|
|
63
63
|
|
64
64
|
#################################################################
|
@@ -1,12 +1,23 @@
|
|
1
1
|
/**
|
2
2
|
*
|
3
3
|
* Darkfish Page Functions
|
4
|
-
* $Id: darkfish.js
|
4
|
+
* $Id: darkfish.js 30 2008-08-20 01:28:01Z deveiant $
|
5
5
|
*
|
6
6
|
* Author: Michael Granger <mgranger@laika.com>
|
7
7
|
*
|
8
8
|
*/
|
9
9
|
|
10
|
+
/* Provide console simulation for firebug-less environments */
|
11
|
+
if (!("console" in window) || !("firebug" in console)) {
|
12
|
+
var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
|
13
|
+
"group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
|
14
|
+
|
15
|
+
window.console = {};
|
16
|
+
for (var i = 0; i < names.length; ++i)
|
17
|
+
window.console[names[i]] = function() {};
|
18
|
+
};
|
19
|
+
|
20
|
+
|
10
21
|
/**
|
11
22
|
* Unwrap the first element that matches the given @expr@ from the targets and return them.
|
12
23
|
*/
|
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
/*
|
7
7
|
* "Darkfish" Rdoc CSS
|
8
|
-
* $Id: rdoc.css
|
8
|
+
* $Id: rdoc.css 30 2008-08-20 01:28:01Z deveiant $
|
9
9
|
*
|
10
10
|
* Author: Michael Granger <ged@FaerieMUD.org>
|
11
11
|
*
|
@@ -254,25 +254,30 @@ ul.link-list .type {
|
|
254
254
|
line-height: 1.4em;
|
255
255
|
}
|
256
256
|
|
257
|
-
#description dl
|
257
|
+
#description dl,
|
258
|
+
#documentation dl {
|
258
259
|
margin: 8px 1.5em;
|
259
260
|
border: 1px solid #ccc;
|
261
|
+
}
|
262
|
+
#description dl {
|
260
263
|
font-size: 14px;
|
261
264
|
}
|
262
265
|
|
263
|
-
#description dt
|
266
|
+
#description dt,
|
267
|
+
#documentation dt {
|
264
268
|
padding: 2px 4px;
|
265
269
|
font-weight: bold;
|
266
270
|
background: #ddd;
|
267
271
|
}
|
268
|
-
#description dd
|
272
|
+
#description dd,
|
273
|
+
#documentation dd {
|
269
274
|
padding: 2px 12px;
|
270
275
|
}
|
271
|
-
#description dd + dt
|
276
|
+
#description dd + dt,
|
277
|
+
#documentation dd + dt {
|
272
278
|
margin-top: 0.7em;
|
273
279
|
}
|
274
280
|
|
275
|
-
|
276
281
|
#documentation .section {
|
277
282
|
font-size: 90%;
|
278
283
|
}
|
@@ -364,6 +369,9 @@ ul.link-list .type {
|
|
364
369
|
#documentation .method-description p {
|
365
370
|
padding: 0;
|
366
371
|
}
|
372
|
+
#documentation .method-description p + p {
|
373
|
+
margin-bottom: 0.5em;
|
374
|
+
}
|
367
375
|
|
368
376
|
#documentation .attribute-method-heading {
|
369
377
|
background: url(images/tag_green.png) no-repeat left bottom;
|
data/rake/publishing.rb
CHANGED
@@ -133,7 +133,7 @@ begin
|
|
133
133
|
task :project => [ :rdoc ] do
|
134
134
|
when_writing( "Publishing docs to #{PROJECT_SCPDOCURL}" ) do
|
135
135
|
run 'ssh', PROJECT_HOST, "rm -rf #{PROJECT_SCPDOCURL}"
|
136
|
-
run 'scp', '-qCr', 'docs', PROJECT_SCPDOCURL
|
136
|
+
run 'scp', '-qCr', 'docs/html', PROJECT_SCPDOCURL
|
137
137
|
end
|
138
138
|
when_writing( "Uploading packages") do
|
139
139
|
pkgs = Pathname.glob( PKGDIR + "#{PKG_FILE_NAME}.{gem,tar.gz,tar.bz2,zip}" )
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: darkfish-rdoc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.1.
|
4
|
+
version: 1.1.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Michael Granger
|
@@ -9,7 +9,7 @@ autorequire:
|
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
11
|
|
12
|
-
date: 2008-08-
|
12
|
+
date: 2008-08-19 00:00:00 -07:00
|
13
13
|
default_executable:
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|