rdoc-generator-fivefish 0.0.1.pre16

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.
Files changed (30) hide show
  1. data/.autotest +23 -0
  2. data/History.rdoc +4 -0
  3. data/Manifest.txt +27 -0
  4. data/README.rdoc +74 -0
  5. data/Rakefile +78 -0
  6. data/data/rdoc-generator-fivefish/css/bootstrap-responsive.min.css +4 -0
  7. data/data/rdoc-generator-fivefish/css/bootstrap.min.css +632 -0
  8. data/data/rdoc-generator-fivefish/css/fivefish.css +185 -0
  9. data/data/rdoc-generator-fivefish/fonts/IstokWeb-Bold.woff +0 -0
  10. data/data/rdoc-generator-fivefish/fonts/IstokWeb-BoldItalic.woff +0 -0
  11. data/data/rdoc-generator-fivefish/fonts/IstokWeb-Italic.woff +0 -0
  12. data/data/rdoc-generator-fivefish/fonts/IstokWeb-Regular.woff +0 -0
  13. data/data/rdoc-generator-fivefish/fonts/OFL.txt +94 -0
  14. data/data/rdoc-generator-fivefish/img/glyphicons-halflings-white.png +0 -0
  15. data/data/rdoc-generator-fivefish/img/glyphicons-halflings.png +0 -0
  16. data/data/rdoc-generator-fivefish/js/bootstrap.min.js +1 -0
  17. data/data/rdoc-generator-fivefish/js/fivefish.js +26 -0
  18. data/data/rdoc-generator-fivefish/js/jquery-1.7.1.min.js +4 -0
  19. data/data/rdoc-generator-fivefish/prototype-classpage.html +101 -0
  20. data/data/rdoc-generator-fivefish/prototype.html +325 -0
  21. data/data/rdoc-generator-fivefish/templates/class.tmpl +156 -0
  22. data/data/rdoc-generator-fivefish/templates/file.tmpl +10 -0
  23. data/data/rdoc-generator-fivefish/templates/index.tmpl +40 -0
  24. data/data/rdoc-generator-fivefish/templates/layout.tmpl +94 -0
  25. data/lib/fivefish.rb +28 -0
  26. data/lib/rdoc/discover.rb +5 -0
  27. data/lib/rdoc/generator/fivefish.rb +292 -0
  28. data.tar.gz.sig +3 -0
  29. metadata +174 -0
  30. metadata.gz.sig +3 -0
data/.autotest ADDED
@@ -0,0 +1,23 @@
1
+ # -*- ruby -*-
2
+
3
+ require 'autotest/restart'
4
+
5
+ # Autotest.add_hook :initialize do |at|
6
+ # at.extra_files << "../some/external/dependency.rb"
7
+ #
8
+ # at.libs << ":../some/external"
9
+ #
10
+ # at.add_exception 'vendor'
11
+ #
12
+ # at.add_mapping(/dependency.rb/) do |f, _|
13
+ # at.files_matching(/test_.*rb$/)
14
+ # end
15
+ #
16
+ # %w(TestA TestB).each do |klass|
17
+ # at.extra_class_map[klass] = "test/test_misc.rb"
18
+ # end
19
+ # end
20
+
21
+ # Autotest.add_hook :run_command do |at|
22
+ # system "rake build"
23
+ # end
data/History.rdoc ADDED
@@ -0,0 +1,4 @@
1
+ == v0.0.1 [2012-03-11] Michael Granger <ged@FaerieMUD.org>
2
+
3
+ Initial release.
4
+
data/Manifest.txt ADDED
@@ -0,0 +1,27 @@
1
+ .autotest
2
+ History.rdoc
3
+ Manifest.txt
4
+ README.rdoc
5
+ Rakefile
6
+ data/rdoc-generator-fivefish/css/bootstrap-responsive.min.css
7
+ data/rdoc-generator-fivefish/css/bootstrap.min.css
8
+ data/rdoc-generator-fivefish/css/fivefish.css
9
+ data/rdoc-generator-fivefish/fonts/IstokWeb-Bold.woff
10
+ data/rdoc-generator-fivefish/fonts/IstokWeb-BoldItalic.woff
11
+ data/rdoc-generator-fivefish/fonts/IstokWeb-Italic.woff
12
+ data/rdoc-generator-fivefish/fonts/IstokWeb-Regular.woff
13
+ data/rdoc-generator-fivefish/fonts/OFL.txt
14
+ data/rdoc-generator-fivefish/img/glyphicons-halflings-white.png
15
+ data/rdoc-generator-fivefish/img/glyphicons-halflings.png
16
+ data/rdoc-generator-fivefish/js/bootstrap.min.js
17
+ data/rdoc-generator-fivefish/js/fivefish.js
18
+ data/rdoc-generator-fivefish/js/jquery-1.7.1.min.js
19
+ data/rdoc-generator-fivefish/prototype-classpage.html
20
+ data/rdoc-generator-fivefish/prototype.html
21
+ data/rdoc-generator-fivefish/templates/class.tmpl
22
+ data/rdoc-generator-fivefish/templates/file.tmpl
23
+ data/rdoc-generator-fivefish/templates/index.tmpl
24
+ data/rdoc-generator-fivefish/templates/layout.tmpl
25
+ lib/fivefish.rb
26
+ lib/rdoc/discover.rb
27
+ lib/rdoc/generator/fivefish.rb
data/README.rdoc ADDED
@@ -0,0 +1,74 @@
1
+ = Fivefish RDoc
2
+
3
+ * http://deveiate.org/fivefish.html
4
+
5
+
6
+ == Description
7
+
8
+ A(nother) HTML(5) generator for RDoc.
9
+
10
+ The goals for this one:
11
+
12
+ * Update Darkfish's semantic structure for HTML5
13
+ * Clean up the layout with a 960 grid
14
+ * Devote more real estate to docs rather than the index
15
+ * Demonstrate themability of RDoc in general via the --stylesheet option
16
+ * Make the output validate again.
17
+
18
+
19
+ == Installation
20
+
21
+ gem install rdoc-generator-fivefish
22
+
23
+
24
+ == Usage
25
+
26
+ rdoc --format=fivefish
27
+
28
+
29
+ == Contributing
30
+
31
+ You can check out the current development source
32
+ {with Mercurial}[http://repo.deveiate.org/Fivefish], or if you prefer Git, via the
33
+ project's {Github mirror}[https://github.com/ged/Fivefish-RDoc].
34
+
35
+ After checking out the source, run:
36
+
37
+ $ rake newb
38
+
39
+ This task will install any missing dependencies, run the tests/specs,
40
+ and generate the API documentation.
41
+
42
+
43
+ == License
44
+
45
+ Copyright © 2012, Michael Granger
46
+ All rights reserved.
47
+
48
+ Redistribution and use in source and binary forms, with or without
49
+ modification, are permitted provided that the following conditions are met:
50
+
51
+ * Redistributions of source code must retain the above copyright notice,
52
+ this list of conditions and the following disclaimer.
53
+
54
+ * Redistributions in binary form must reproduce the above copyright notice,
55
+ this list of conditions and the following disclaimer in the documentation
56
+ and/or other materials provided with the distribution.
57
+
58
+ * Neither the name of the author/s, nor the names of the project's
59
+ contributors may be used to endorse or promote products derived from this
60
+ software without specific prior written permission.
61
+
62
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
63
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
64
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
65
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
66
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
67
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
68
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
69
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
70
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
71
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
72
+
73
+
74
+
data/Rakefile ADDED
@@ -0,0 +1,78 @@
1
+ #! -*- ruby -*-
2
+
3
+ require 'pathname'
4
+
5
+ begin
6
+ require 'hoe'
7
+ rescue LoadError
8
+ abort "This Rakefile requires hoe (gem install hoe)"
9
+ end
10
+
11
+ Hoe.add_include_dirs 'lib'
12
+
13
+ gem 'rdoc', '~> 3.12'
14
+ require 'fivefish'
15
+ require 'rdoc/task'
16
+ require 'rake'
17
+ require 'rake/clean'
18
+
19
+ PACKAGE_NAME = 'rdoc-generator-fivefish'
20
+ BASEDIR = Pathname( __FILE__ ).dirname
21
+ DATADIR = BASEDIR + "data/#{PACKAGE_NAME}"
22
+
23
+ FONTSDIR = DATADIR + 'fonts'
24
+ TTF_FONTS = FileList[ (FONTSDIR + '*.ttf').to_s ]
25
+ WOFF_FONTS = TTF_FONTS.pathmap( '%X.woff' )
26
+
27
+ CLEAN.include( WOFF_FONTS )
28
+
29
+
30
+ Hoe.plugin :deveiate
31
+ Hoe.plugin :mercurial
32
+ Hoe.plugin :signing
33
+ Hoe.plugin :manualgen
34
+
35
+ Hoe.plugins.delete :rubyforge
36
+
37
+ hoespec = Hoe.spec( PACKAGE_NAME ) do
38
+ self.readme_file = 'README.rdoc'
39
+ self.history_file = 'History.rdoc'
40
+ self.extra_rdoc_files << 'README.rdoc' << 'History.rdoc'
41
+ self.need_rdoc = false
42
+
43
+ self.developer 'Michael Granger', 'ged@FaerieMUD.org'
44
+
45
+ self.dependency 'inversion', '~> 0.5'
46
+ self.dependency 'rdoc', '~> 3.12'
47
+
48
+ self.spec_extras[:licenses] = ["BSD"]
49
+ self.require_ruby_version( '>=1.9.3' )
50
+ self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
51
+ self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
52
+ self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
53
+ end
54
+
55
+ ENV['VERSION'] ||= hoespec.spec.version.to_s
56
+
57
+ # Ensure the specs pass before checking in
58
+ task 'hg:precheckin' => [:check_history, :check_manifest, :spec]
59
+
60
+
61
+ RDoc::Task.new( :docs ) do |rdoc|
62
+ rdoc.main = "README.rdoc"
63
+ rdoc.rdoc_dir = 'doc'
64
+ rdoc.generator = 'fivefish'
65
+
66
+ rdoc.rdoc_files.include( 'README.rdoc', 'History.rdoc', 'lib/**/*.rb' )
67
+ end
68
+
69
+
70
+ task :check_manifest => WOFF_FONTS
71
+
72
+
73
+ desc "Compress truetype fonts to WOFF"
74
+ rule '.woff' => '.ttf' do |task|
75
+ sh 'sfnt2woff', task.prerequisites.first
76
+ end
77
+
78
+
@@ -0,0 +1,4 @@
1
+ .clearfix{*zoom:1;}.clearfix:before,.clearfix:after{display:table;content:"";}
2
+ .clearfix:after{clear:both;}
3
+ .hidden{display:none;visibility:hidden;}
4
+ @media (max-width:480px){.nav-collapse{-webkit-transform:translate3d(0, 0, 0);} .page-header h1 small{display:block;line-height:18px;} input[class*="span"],select[class*="span"],textarea[class*="span"],.uneditable-input{display:block;width:100%;min-height:28px;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;-ms-box-sizing:border-box;box-sizing:border-box;} .input-prepend input[class*="span"],.input-append input[class*="span"]{width:auto;} input[type="checkbox"],input[type="radio"]{border:1px solid #ccc;} .form-horizontal .control-group>label{float:none;width:auto;padding-top:0;text-align:left;} .form-horizontal .controls{margin-left:0;} .form-horizontal .control-list{padding-top:0;} .form-horizontal .form-actions{padding-left:10px;padding-right:10px;} .modal{position:absolute;top:10px;left:10px;right:10px;width:auto;margin:0;}.modal.fade.in{top:auto;} .modal-header .close{padding:10px;margin:-10px;} .carousel-caption{position:static;}}@media (max-width:767px){.container{width:auto;padding:0 20px;} .row-fluid{width:100%;} .row{margin-left:0;} .row>[class*="span"],.row-fluid>[class*="span"]{float:none;display:block;width:auto;margin:0;}}@media (min-width:768px) and (max-width:979px){.row{margin-left:-20px;*zoom:1;}.row:before,.row:after{display:table;content:"";} .row:after{clear:both;} [class*="span"]{float:left;margin-left:20px;} .span1{width:42px;} .span2{width:104px;} .span3{width:166px;} .span4{width:228px;} .span5{width:290px;} .span6{width:352px;} .span7{width:414px;} .span8{width:476px;} .span9{width:538px;} .span10{width:600px;} .span11{width:662px;} .span12,.container{width:724px;} .offset1{margin-left:82px;} .offset2{margin-left:144px;} .offset3{margin-left:206px;} .offset4{margin-left:268px;} .offset5{margin-left:330px;} .offset6{margin-left:392px;} .offset7{margin-left:454px;} .offset8{margin-left:516px;} .offset9{margin-left:578px;} .offset10{margin-left:640px;} .offset11{margin-left:702px;} .row-fluid{width:100%;*zoom:1;}.row-fluid:before,.row-fluid:after{display:table;content:"";} .row-fluid:after{clear:both;} .row-fluid>[class*="span"]{float:left;margin-left:2.762430939%;} .row-fluid>[class*="span"]:first-child{margin-left:0;} .row-fluid>.span1{width:5.801104972%;} .row-fluid>.span2{width:14.364640883%;} .row-fluid>.span3{width:22.928176794%;} .row-fluid>.span4{width:31.491712705%;} .row-fluid>.span5{width:40.055248616%;} .row-fluid>.span6{width:48.618784527%;} .row-fluid>.span7{width:57.182320438000005%;} .row-fluid>.span8{width:65.74585634900001%;} .row-fluid>.span9{width:74.30939226%;} .row-fluid>.span10{width:82.87292817100001%;} .row-fluid>.span11{width:91.436464082%;} .row-fluid>.span12{width:99.999999993%;} input.span1,textarea.span1,.uneditable-input.span1{width:32px;} input.span2,textarea.span2,.uneditable-input.span2{width:94px;} input.span3,textarea.span3,.uneditable-input.span3{width:156px;} input.span4,textarea.span4,.uneditable-input.span4{width:218px;} input.span5,textarea.span5,.uneditable-input.span5{width:280px;} input.span6,textarea.span6,.uneditable-input.span6{width:342px;} input.span7,textarea.span7,.uneditable-input.span7{width:404px;} input.span8,textarea.span8,.uneditable-input.span8{width:466px;} input.span9,textarea.span9,.uneditable-input.span9{width:528px;} input.span10,textarea.span10,.uneditable-input.span10{width:590px;} input.span11,textarea.span11,.uneditable-input.span11{width:652px;} input.span12,textarea.span12,.uneditable-input.span12{width:714px;}}@media (max-width:979px){body{padding-top:0;} .navbar-fixed-top{position:static;margin-bottom:18px;} .navbar-fixed-top .navbar-inner{padding:5px;} .navbar .container{width:auto;padding:0;} .navbar .brand{padding-left:10px;padding-right:10px;margin:0 0 0 -5px;} .navbar .nav-collapse{clear:left;} .navbar .nav{float:none;margin:0 0 9px;} .navbar .nav>li{float:none;} .navbar .nav>li>a{margin-bottom:2px;} .navbar .nav>.divider-vertical{display:none;} .navbar .nav .nav-header{color:#999999;text-shadow:none;} .navbar .nav>li>a,.navbar .dropdown-menu a{padding:6px 15px;font-weight:bold;color:#999999;-webkit-border-radius:3px;-moz-border-radius:3px;border-radius:3px;} .navbar .dropdown-menu li+li a{margin-bottom:2px;} .navbar .nav>li>a:hover,.navbar .dropdown-menu a:hover{background-color:#222222;} .navbar .dropdown-menu{position:static;top:auto;left:auto;float:none;display:block;max-width:none;margin:0 15px;padding:0;background-color:transparent;border:none;-webkit-border-radius:0;-moz-border-radius:0;border-radius:0;-webkit-box-shadow:none;-moz-box-shadow:none;box-shadow:none;} .navbar .dropdown-menu:before,.navbar .dropdown-menu:after{display:none;} .navbar .dropdown-menu .divider{display:none;} .navbar-form,.navbar-search{float:none;padding:9px 15px;margin:9px 0;border-top:1px solid #222222;border-bottom:1px solid #222222;-webkit-box-shadow:inset 0 1px 0 rgba(255, 255, 255, 0.1),0 1px 0 rgba(255, 255, 255, 0.1);-moz-box-shadow:inset 0 1px 0 rgba(255, 255, 255, 0.1),0 1px 0 rgba(255, 255, 255, 0.1);box-shadow:inset 0 1px 0 rgba(255, 255, 255, 0.1),0 1px 0 rgba(255, 255, 255, 0.1);} .navbar .nav.pull-right{float:none;margin-left:0;} .navbar-static .navbar-inner{padding-left:10px;padding-right:10px;} .btn-navbar{display:block;} .nav-collapse{overflow:hidden;height:0;}}@media (min-width:980px){.nav-collapse.collapse{height:auto !important;}}@media (min-width:1200px){.row{margin-left:-30px;*zoom:1;}.row:before,.row:after{display:table;content:"";} .row:after{clear:both;} [class*="span"]{float:left;margin-left:30px;} .span1{width:70px;} .span2{width:170px;} .span3{width:270px;} .span4{width:370px;} .span5{width:470px;} .span6{width:570px;} .span7{width:670px;} .span8{width:770px;} .span9{width:870px;} .span10{width:970px;} .span11{width:1070px;} .span12,.container{width:1170px;} .offset1{margin-left:130px;} .offset2{margin-left:230px;} .offset3{margin-left:330px;} .offset4{margin-left:430px;} .offset5{margin-left:530px;} .offset6{margin-left:630px;} .offset7{margin-left:730px;} .offset8{margin-left:830px;} .offset9{margin-left:930px;} .offset10{margin-left:1030px;} .offset11{margin-left:1130px;} .row-fluid{width:100%;*zoom:1;}.row-fluid:before,.row-fluid:after{display:table;content:"";} .row-fluid:after{clear:both;} .row-fluid>[class*="span"]{float:left;margin-left:2.564102564%;} .row-fluid>[class*="span"]:first-child{margin-left:0;} .row-fluid>.span1{width:5.982905983%;} .row-fluid>.span2{width:14.529914530000001%;} .row-fluid>.span3{width:23.076923077%;} .row-fluid>.span4{width:31.623931624%;} .row-fluid>.span5{width:40.170940171000005%;} .row-fluid>.span6{width:48.717948718%;} .row-fluid>.span7{width:57.264957265%;} .row-fluid>.span8{width:65.81196581200001%;} .row-fluid>.span9{width:74.358974359%;} .row-fluid>.span10{width:82.905982906%;} .row-fluid>.span11{width:91.45299145300001%;} .row-fluid>.span12{width:100%;} input.span1,textarea.span1,.uneditable-input.span1{width:60px;} input.span2,textarea.span2,.uneditable-input.span2{width:160px;} input.span3,textarea.span3,.uneditable-input.span3{width:260px;} input.span4,textarea.span4,.uneditable-input.span4{width:360px;} input.span5,textarea.span5,.uneditable-input.span5{width:460px;} input.span6,textarea.span6,.uneditable-input.span6{width:560px;} input.span7,textarea.span7,.uneditable-input.span7{width:660px;} input.span8,textarea.span8,.uneditable-input.span8{width:760px;} input.span9,textarea.span9,.uneditable-input.span9{width:860px;} input.span10,textarea.span10,.uneditable-input.span10{width:960px;} input.span11,textarea.span11,.uneditable-input.span11{width:1060px;} input.span12,textarea.span12,.uneditable-input.span12{width:1160px;} .thumbnails{margin-left:-30px;} .thumbnails>li{margin-left:30px;}}