rdoc 3.10.pre.2 → 3.10.pre.3

data/{History.txt → History.rdoc}

@@ -19,7 +19,7 @@
     The default markup can be set via the <tt>--markup</tt> option.
 
     The format of documentation in a particular file can be specified by the
-    +:markup:+ directive.  If the :markup: directive is in the first comment
+    +:markup:+ directive.  If the +:markup:+ directive is in the first comment
     it is used as the default for the entire file.  For other comments it
     overrides the default markup format.
 
@@ -39,7 +39,7 @@
     <tt>RDoc::Markup@Links</tt>
 
     See RDoc::Markup@Links for further details.
-  * RDoc now looks for a <tt>format: parser_name</tt> magic comment to choose
+  * RDoc now looks for a <tt>markup: parser_name</tt> magic comment to choose
     alternate documentation formats.  The format comment must be in the first
     three lines of the file (to allow for a shebang or modeline).
   * RDoc makes an effort to syntax-highlight ruby code in verbatim sections.

data/Manifest.txt

@@ -1,14 +1,15 @@
 .autotest
 .document
-History.txt
+History.rdoc
 LICENSE.rdoc
 Manifest.txt
-README.txt
-RI.txt
+README.rdoc
+RI.rdoc
 Rakefile
 TODO.rdoc
 bin/rdoc
 bin/ri
+lib/gauntlet_rdoc.rb
 lib/rdoc.rb
 lib/rdoc/alias.rb
 lib/rdoc/anon_class.rb
@@ -24,7 +25,6 @@ lib/rdoc/context/section.rb
 lib/rdoc/cross_reference.rb
 lib/rdoc/encoding.rb
 lib/rdoc/erbio.rb
-lib/rdoc/gauntlet.rb
 lib/rdoc/generator.rb
 lib/rdoc/generator/darkfish.rb
 lib/rdoc/generator/json_index.rb
@@ -44,7 +44,6 @@ lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml
 lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
 lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
 lib/rdoc/generator/template/darkfish/class.rhtml
-lib/rdoc/generator/template/darkfish/fileinfo.rhtml
 lib/rdoc/generator/template/darkfish/images/add.png
 lib/rdoc/generator/template/darkfish/images/brick.png
 lib/rdoc/generator/template/darkfish/images/brick_link.png

data/{README.txt → README.rdoc}

@@ -1,10 +1,10 @@
 = \RDoc - Ruby Documentation System
 
-* {RDoc Project Page}[https://github.com/rdoc/rdoc/]
-* {RDoc Documentation}[http://docs.seattlerb.org/rdoc]
-* {RDoc Bug Tracker}[https://github.com/rdoc/rdoc/issues]
+home :: https://github.com/rdoc/rdoc
+rdoc :: http://docs.seattlerb.org/rdoc
+bugs :: https://github.com/rdoc/rdoc/issues
 
-== DESCRIPTION:
+== Description
 
 RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
 includes the +rdoc+ and +ri+ tools for generating and displaying online
@@ -12,7 +12,7 @@ documentation.
 
 See RDoc for a description of RDoc's markup and basic use.
 
-== SYNOPSIS:
+== Synopsis
 
 To learn RDoc's syntax and directives for documenting your ruby project see
 RDoc::Markup.  RDoc::Parser::Ruby and RDoc::Parser::C have additional
@@ -40,12 +40,12 @@ To generate documentation programmatically:
   rdoc.document options
   # see RDoc::RDoc
 
-== BUGS:
+== Bugs
 
 If you find a bug, please report it at the RDoc project's
 {issues tracker}[https://github.com/rdoc/rdoc/issues] on github
 
-== LICENSE:
+== License
 
 RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
 Portions (c) 2007-2011 Eric Hodel.  Portions copyright others, see individual
@@ -54,7 +54,7 @@ files for details.
 It is free software, and may be redistributed under the terms specified in
 LICENSE.txt.
 
-== WARRANTY:
+== Warranty
 
 This software is provided "as is" and without any express or implied
 warranties, including, without limitation, the implied warranties of

data/RI.rdoc

@@ -0,0 +1,57 @@
+= RI
+
++ri+ is a tool that allows Ruby documentation to be viewed on the command-line.
+
+You can use +ri+ to look up information from either the command line or
+interactively.  When you run +ri+ without any arguments it will launch in
+interactive mode.  In interactive mode you can tab-complete class and method
+names.
+
+== Usage
+
+To see information for a class, do:
+  ri ClassName
+
+For example, for the Array class, do:
+  ri Array
+
+To see information on a method on a class, do:
+  ri ClassName.method
+
+This will show both instance and class methods.  For example, the IO
+class defines both IO::read and IO#read:
+  ri IO.read
+
+To see information for an instance method, do:
+  ri ClassName#method_name
+
+For example, for Array's +join+ method, do:
+  ri Array#join
+
+To see information for a class method, do:
+  ri ClassName::method_name
+
+For example, for Module's +private+ method, do:
+  ri Module::private
+
+To read documentation for all +read+ methods, do:
+  ri read
+
+== Options
+
++ri+ supports a variety of options, all of which can be viewed via +--help+.
+Of particular interest, are:
+
+[<tt>-f</tt>]
+  Outputs ri data using the selected formatter.  You can see the available
+  formatters in <tt>ri --help</tt>
+[<tt>-T</tt>]
+  Send output to stdout, rather than to a pager.
+
+All options also can be specified through the +RI+ environment variable.
+Command-line options always override those specified in the +RI+ environment
+variable.
+
+The +RI_PAGER+ environment variable allows you to choose a particular pager or
+particular options for your pager.
+

data/Rakefile

@@ -35,7 +35,16 @@ Depending on your version of ruby, you may need to install ruby rdoc/ri data:
 >= 1.9.2 : nothing to do! Yay!
   MESSAGE
 
+  self.readme_file  = 'README.rdoc'
+  self.history_file = 'History.rdoc'
   self.testlib = :minitest
+  self.extra_rdoc_files += %w[
+    History.rdoc
+    LICENSE.rdoc
+    README.rdoc
+    RI.rdoc
+    TODO.rdoc
+  ]
 
   self.clean_globs += PARSER_FILES
 

data/TODO.rdoc

@@ -1,6 +1,6 @@
 Some file contains some things that might happen in RDoc, or might not
 
-=== RDoc 3.11
+=== 3.11
 
 * Reload the RDoc tree from an RI store
   * Re-run generators
@@ -12,7 +12,7 @@ Some file contains some things that might happen in RDoc, or might not
 * Remove Public in HTML output if there are only public methods
 * Method markup support for rd documentation
 
-=== RDoc 4
+=== 4
 
 API changes to RDoc
 

data/lib/rdoc.rb

@@ -1,6 +1,6 @@
 $DEBUG_RDOC = nil
 
-# :main: README.txt
+# :main: README.rdoc
 
 ##
 # RDoc is a Ruby documentation system which contains RDoc::RDoc for generating
@@ -61,7 +61,7 @@ $DEBUG_RDOC = nil
 # index page contain the documentation for the primary file.  In our
 # case, we could type
 #
-#   % rdoc --main README.txt
+#   % rdoc --main README.rdoc
 #
 # You'll find information on the various formatting tricks you can use
 # in comment blocks in the documentation this generates.

data/lib/rdoc/cross_reference.rb

@@ -116,16 +116,6 @@ class RDoc::CrossReference
   def resolve name, text
     return @seen[name] if @seen.include? name
 
-    # Find class, module, or method in class or module.
-    #
-    # Do not, however, use an if/elsif/else chain to do so.  Instead, test
-    # each possible pattern until one matches.  The reason for this is that a
-    # string like "YAML.txt" could be the txt() class method of class YAML (in
-    # which case it would match the first pattern, which splits the string
-    # into container and method components and looks up both) or a filename
-    # (in which case it would match the last pattern, which just checks
-    # whether the string as a whole is a known symbol).
-
     if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
       type = $2
       type = '' if type == '.'  # will find either #method or ::method
@@ -150,12 +140,15 @@ class RDoc::CrossReference
 
     ref = case name
           when /^\\(#{CLASS_REGEXP_STR})$/o then
-            ref = @context.find_symbol $1
+            @context.find_symbol $1
           else
-            ref = @context.find_symbol name
+            @context.find_symbol name
           end unless ref
 
-    ref = nil if RDoc::Alias === ref # external alias: can't link to it
+    # Try a page name
+    ref = RDoc::TopLevel.page name if not ref and name =~ /^\w+$/
+
+    ref = nil if RDoc::Alias === ref # external alias, can't link to it
 
     out = if name == '\\' then
             name

data/lib/rdoc/generator/darkfish.rb

@@ -199,13 +199,13 @@ class RDoc::Generator::Darkfish
 
     @options.static_path.each do |path|
       unless File.directory? path then
-        FileUtils.install path, @base_dir, fu_options.merge(:mode => 0644)
+        FileUtils.install path, @outputdir, fu_options.merge(:mode => 0644)
         next
       end
 
       Dir.chdir path do
         Dir[File.join('**', '*')].each do |entry|
-          dest_file = @base_dir + entry
+          dest_file = @outputdir + entry
 
           if File.directory? entry then
             FileUtils.mkdir_p entry, fu_options
@@ -348,7 +348,7 @@ class RDoc::Generator::Darkfish
 
     debug_msg "Rendering the Table of Contents..."
 
-    out_file = @base_dir + @options.op_dir + 'table_of_contents.html'
+    out_file = @outputdir + 'table_of_contents.html'
     # suppress 1.9.3 warning
     rel_prefix = rel_prefix = @outputdir.relative_path_from(out_file.dirname)
     @title = "Table of Contents"

data/lib/rdoc/generator/template/darkfish/rdoc.css

@@ -470,12 +470,6 @@ pre {
 
 /* @group Source Code */
 
-.method-source-code pre {
-  overflow: auto;
-}
-
-/* @group Ruby keyword styles */
-
 pre {
   overflow: auto;
   background: #262626;
@@ -499,61 +493,7 @@ pre {
 .ruby-value      { color: #7fffd4; background: transparent; }
 
 /* @end */
-/* @end */
-
-
-/* @group File Popup Contents */
-
-.file-popup dl {
-  font-size: 80%;
-  padding: 0.75em;
-  background-color: #dedede;
-  color: #333;
-  border: 1px solid #bbb;
-  -moz-border-radius: 3px;
-  -webkit-border-radius: 3px;
-}
-.file dt {
-  font-weight: bold;
-  padding-left: 22px;
-  line-height: 20px;
-  background: url(images/page_white_width.png) no-repeat left top;
-}
-.file dt.modified-date {
-  background: url(images/date.png) no-repeat left top;
-}
-.file dt.requires {
-  background: url(images/plugin.png) no-repeat left top;
-}
-.file dt.scs-url {
-  background: url(images/wrench.png) no-repeat left top;
-}
-
-.file dl dd {
-  margin: 0 0 1em 0;
-}
-.file #metadata dl dd ul {
-  list-style: circle;
-  margin-left: 20px;
-  padding-top: 0;
-}
-.file #metadata dl dd ul li {
-}
-
-/*
-.file h2 {
-  margin-top: 2em;
-  padding: 0.75em 0.5em;
-  background-color: #dedede;
-  color: #333;
-  font-size: 120%;
-  border: 1px solid #bbb;
-  -moz-border-radius: 3px;
-  -webkit-border-radius: 3px;
-}
-*/
 
-/* @end */
 
 /* @group search results */
 #search-results h1 {

data/lib/rdoc/parser.rb

@@ -150,7 +150,7 @@ class RDoc::Parser
   def self.for top_level, file_name, content, options, stats
     return if binary? file_name
 
-    parser = use_format content
+    parser = use_markup content
 
     unless parser then
       # If no extension, look for shebang
@@ -180,10 +180,10 @@ class RDoc::Parser
   end
 
   ##
-  # If there is a <tt>format: parser_name</tt> comment at the front of the
+  # If there is a <tt>markup: parser_name</tt> comment at the front of the
   # file, use it to determine the parser.  For example:
   #
-  #   # format: rdoc
+  #   # markup: rdoc
   #   # Class comment can go here
   #
   #   class C
@@ -194,17 +194,19 @@ class RDoc::Parser
   # If the content contains a shebang or editor modeline the comment may
   # appear on the second or third line.
   #
-  # Any comment style may be used to hide the format comment.
+  # Any comment style may be used to hide the markup comment.
 
-  def self.use_format content
-    format = content.lines.first(3).grep(/format:\s+(\w+)/) { $1 }.first
+  def self.use_markup content
+    markup = content.lines.first(3).grep(/markup:\s+(\w+)/) { $1 }.first
 
-    return unless format
+    return unless markup
 
-    format = Regexp.escape format
+    return RDoc::Parser::Ruby if markup == 'tomdoc'
+
+    markup = Regexp.escape markup
 
     RDoc::Parser.parsers.find do |_, parser|
-      /^#{format}$/i =~ parser.name.sub(/.*:/, '')
+      /^#{markup}$/i =~ parser.name.sub(/.*:/, '')
     end.last
   end
 

data/lib/rdoc/parser/ruby.rb

@@ -575,7 +575,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
   ##
   # Parses a class in +context+ with +comment+
 
-  def parse_class(container, single, tk, comment)
+  def parse_class container, single, tk, comment
     offset  = tk.seek
     line_no = tk.line_no
 
@@ -728,7 +728,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
     read_documentation_modifiers con, RDoc::CONSTANT_MODIFIERS
 
     @stats.add_constant con
-    container.add_constant con
+    con = container.add_constant con
+
     true
   end
 
@@ -1240,17 +1241,18 @@ class RDoc::Parser::Ruby < RDoc::Parser
   ##
   # Parses an RDoc::NormalModule in +container+ with +comment+
 
-  def parse_module(container, single, tk, comment)
+  def parse_module container, single, tk, comment
     container, name_t, = get_class_or_module container
 
     name = name_t.name
 
     mod = container.add_module RDoc::NormalModule, name
+    mod.ignore unless container.document_children
     mod.record_location @top_level
 
     read_documentation_modifiers mod, RDoc::CLASS_MODIFIERS
     mod.add_comment comment, @top_level
-    parse_statements(mod)
+    parse_statements mod
 
     @top_level.add_to_classes_or_modules mod
     @stats.add_module mod
@@ -1344,11 +1346,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
         parse_class container, single, tk, comment
 
       when TkMODULE then
-        if container.document_children then
-          parse_module container, single, tk, comment
-        else
-          nest += 1
-        end
+        parse_module container, single, tk, comment
 
       when TkDEF then
         parse_method container, single, tk, comment
@@ -1690,6 +1688,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     catch :eof do
       begin
         parse_top_level_statements @top_level
+
       rescue StandardError => e
         bytes = ''
 

data/lib/rdoc/stats.rb

@@ -352,7 +352,8 @@ class RDoc::Stats
       next if method.documented? and not param_report
       report << "  # in file #{method.file.full_name}"
       report << param_report if param_report
-      report << "  def #{method.name}#{method.params}; end"
+      scope = method.singleton ? 'self.' : nil
+      report << "  def #{scope}#{method.name}#{method.params}; end"
       report << nil
     end
 

data/lib/rdoc/top_level.rb

@@ -231,6 +231,15 @@ class RDoc::TopLevel < RDoc::Context
     end
   end
 
+  ##
+  # Returns the RDoc::TopLevel that has the given +name+
+
+  def self.page name
+    @all_files_hash.each_value.find do |file|
+      file.text? and file.page_name == name
+    end
+  end
+
   ##
   # Removes from +all_hash+ the contexts that are nodoc or have no content.
   #
@@ -328,7 +337,7 @@ class RDoc::TopLevel < RDoc::Context
   ##
   # Adds +constant+ to +Object+ instead of +self+.
 
-  def add_constant(constant)
+  def add_constant constant
     object_class.record_location self
     return constant unless @document_self
     object_class.add_constant constant
@@ -495,7 +504,7 @@ class RDoc::TopLevel < RDoc::Context
   # Is this TopLevel from a text file instead of a source code file?
 
   def text?
-    @parser.ancestors.include? RDoc::Parser::Text
+    @parser and @parser.ancestors.include? RDoc::Parser::Text
   end
 
   def to_s # :nodoc:

data/test/test_rdoc_context.rb

@@ -6,6 +6,8 @@ class TestRDocContext < XrefTestCase
     super
 
     @context = RDoc::Context.new
+    @enumerator = # 1.8 vs 1.9
+      Object.const_defined?(:Enumerator) ? Enumerator : Enumerable::Enumerator
   end
 
   def test_initialize
@@ -365,7 +367,7 @@ class TestRDocContext < XrefTestCase
   end
 
   def test_each_method_enumerator
-    assert_kind_of Enumerator, @c1.each_method
+    assert_kind_of @enumerator, @c1.each_method
   end
 
   def test_each_section
@@ -397,7 +399,7 @@ class TestRDocContext < XrefTestCase
   end
 
   def test_each_section_enumerator
-    assert_kind_of Enumerator, @c1.each_section
+    assert_kind_of @enumerator, @c1.each_section
   end
 
   def test_find_attribute_named
@@ -707,7 +709,7 @@ class TestRDocContext < XrefTestCase
     @context = RDoc::Context.new
 
     @context.add_method RDoc::AnyMethod.new(nil, 'm')
-    b = @context.add_section 'B'
+    @context.add_section 'B'
 
     assert_empty @context.section_contents
   end

data/test/test_rdoc_cross_reference.rb

@@ -16,6 +16,13 @@ class TestRDocCrossReference < XrefTestCase
     assert_equal name, @xref.resolve(name, name)
   end
 
+  def test_resolve_page
+    page = RDoc::TopLevel.new 'README.txt'
+    page.parser = RDoc::Parser::Simple
+
+    assert_ref page, 'README'
+  end
+
   def test_resolve_C2
     @xref = RDoc::CrossReference.new @c2
 

data/test/test_rdoc_generator_darkfish.rb

@@ -72,7 +72,6 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
 
     assert_file 'index.html'
     assert_file 'Object.html'
-    assert_file 'file_rb.html'
     assert_file 'table_of_contents.html'
     assert_file 'js/search_index.js'
 
@@ -86,8 +85,6 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
                  File.read('index.html'))
     assert_match(/<meta content="text\/html; charset=#{encoding}"/,
                  File.read('Object.html'))
-    assert_match(/<meta content="text\/html; charset=#{encoding}"/,
-                 File.read('file_rb.html'))
 
     refute_match(/Ignored/, File.read('index.html'))
   end
@@ -101,7 +98,6 @@ class TestRDocGeneratorDarkfish < RDoc::TestCase
 
     refute_file 'index.html'
     refute_file 'Object.html'
-    refute_file 'file_rb.html'
   end
 
   def test_generate_static

data/test/test_rdoc_parser.rb

@@ -81,9 +81,9 @@ class TestRDocParser < RDoc::TestCase
     assert_nil @RP.for(nil, @binary_dat, nil, nil, nil)
   end
 
-  def test_class_for_format
+  def test_class_for_markup
     content = <<-CONTENT
-# coding: utf-8 format: rd
+# coding: utf-8 markup: rd
     CONTENT
 
     parser = @RP.for @top_level, __FILE__, content, @options, nil
@@ -91,53 +91,63 @@ class TestRDocParser < RDoc::TestCase
     assert_kind_of @RP::RD, parser
   end
 
-  def test_class_use_format
+  def test_class_use_markup
     content = <<-CONTENT
-# coding: utf-8 format: rd
+# coding: utf-8 markup: rd
     CONTENT
 
-    parser = @RP.use_format content
+    parser = @RP.use_markup content
 
     assert_equal @RP::RD, parser
   end
 
-  def test_class_use_format_modeline
+  def test_class_use_markup_modeline
     content = <<-CONTENT
 # -*- coding: utf-8 -*-
-# format: rd
+# markup: rd
     CONTENT
 
-    parser = @RP.use_format content
+    parser = @RP.use_markup content
 
     assert_equal @RP::RD, parser
   end
 
-  def test_class_use_format_modeline_shebang
+  def test_class_use_markup_modeline_shebang
     content = <<-CONTENT
 #!/bin/sh
 /* -*- coding: utf-8 -*-
- * format: rd
+ * markup: rd
  */
     CONTENT
 
-    parser = @RP.use_format content
+    parser = @RP.use_markup content
 
     assert_equal @RP::RD, parser
   end
 
-  def test_class_use_format_shebang
+  def test_class_use_markup_shebang
     content = <<-CONTENT
 #!/usr/bin/env ruby
-# coding: utf-8 format: rd
+# coding: utf-8 markup: rd
     CONTENT
 
-    parser = @RP.use_format content
+    parser = @RP.use_markup content
 
     assert_equal @RP::RD, parser
   end
 
-  def test_class_use_format_none
-    parser = @RP.use_format ''
+  def test_class_use_markup_tomdoc
+    content = <<-CONTENT
+# coding: utf-8 markup: tomdoc
+    CONTENT
+
+    parser = @RP.use_markup content
+
+    assert_equal @RP::Ruby, parser
+  end
+
+  def test_class_use_markup_none
+    parser = @RP.use_markup ''
 
     assert_nil parser
   end

data/test/test_rdoc_parser_ruby.rb

@@ -686,7 +686,7 @@ end
 
     foo = @top_level.modules.first
     assert_equal 'Foo', foo.full_name
-    assert_equal 'my module', foo.comment.text
+    assert_empty foo.comment
   end
 
   def test_parse_class_colon3
@@ -2375,6 +2375,24 @@ end
     assert hidden.ignored?
   end
 
+  def test_scan_stopdoc_class_alias
+    util_parser <<-RUBY
+# :stopdoc:
+module A
+  B = C
+end
+    RUBY
+
+    @parser.scan
+
+    assert_empty RDoc::TopLevel.classes
+
+    assert_equal 1, RDoc::TopLevel.modules.length
+    m = RDoc::TopLevel.modules.first
+
+    assert m.ignored?
+  end
+
   def test_stopdoc_after_comment
     util_parser <<-EOS
       module Bar

data/test/test_rdoc_stats.rb

@@ -331,6 +331,40 @@ class C # is documented
   # in file file.rb
   def m1; end
 
+end
+    EXPECTED
+
+    assert_equal expected, report
+  end
+
+  def test_report_method_class
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
+
+    m1 = RDoc::AnyMethod.new nil, 'm1'
+    m1.record_location @tl
+    m1.singleton = true
+    c.add_method m1
+
+    m2 = RDoc::AnyMethod.new nil, 'm2'
+    m2.record_location @tl
+    m2.singleton = true
+    c.add_method m2
+    m2.comment = 'm2'
+
+    RDoc::TopLevel.complete :public
+
+    report = @s.report
+
+    expected = <<-EXPECTED
+The following items are not documented:
+
+class C # is documented
+
+  # in file file.rb
+  def self.m1; end
+
 end
     EXPECTED
 

data/test/test_rdoc_top_level.rb

@@ -89,6 +89,15 @@ class TestRDocTopLevel < XrefTestCase
     refute_same tl1, tl3
   end
 
+  def test_class_page
+    page = RDoc::TopLevel.new 'PAGE.txt'
+    page.parser = RDoc::Parser::Simple
+
+    assert_nil RDoc::TopLevel.page 'no such page'
+
+    assert_equal page, RDoc::TopLevel.page('PAGE')
+  end
+
   def test_class_reset
     RDoc::TopLevel.reset
 
@@ -283,5 +292,13 @@ class TestRDocTopLevel < XrefTestCase
     assert simple.text?
   end
 
+  def test_text_eh_no_parser
+    refute @xref_data.text?
+
+    rd = RDoc::TopLevel.new 'rd_format.rd'
+
+    refute rd.text?
+  end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 1923831869
+  hash: 1923831871
   prerelease: 
   segments: 
   - 3
   - 10
   - pre
-  - 2
-  version: 3.10.pre.2
+  - 3
+  version: 3.10.pre.3
 platform: ruby
 authors: 
 - Eric Hodel
@@ -40,7 +40,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2011-09-28 00:00:00 Z
+date: 2011-10-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -147,23 +147,26 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
 - Manifest.txt
-- README.txt
-- RI.txt
+- History.rdoc
+- LICENSE.rdoc
+- README.rdoc
+- RI.rdoc
+- TODO.rdoc
 - Rakefile
 files: 
 - .autotest
 - .document
-- History.txt
+- History.rdoc
 - LICENSE.rdoc
 - Manifest.txt
-- README.txt
-- RI.txt
+- README.rdoc
+- RI.rdoc
 - Rakefile
 - TODO.rdoc
 - bin/rdoc
 - bin/ri
+- lib/gauntlet_rdoc.rb
 - lib/rdoc.rb
 - lib/rdoc/alias.rb
 - lib/rdoc/anon_class.rb
@@ -179,7 +182,6 @@ files:
 - lib/rdoc/cross_reference.rb
 - lib/rdoc/encoding.rb
 - lib/rdoc/erbio.rb
-- lib/rdoc/gauntlet.rb
 - lib/rdoc/generator.rb
 - lib/rdoc/generator/darkfish.rb
 - lib/rdoc/generator/json_index.rb
@@ -199,7 +201,6 @@ files:
 - lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
 - lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
 - lib/rdoc/generator/template/darkfish/class.rhtml
-- lib/rdoc/generator/template/darkfish/fileinfo.rhtml
 - lib/rdoc/generator/template/darkfish/images/add.png
 - lib/rdoc/generator/template/darkfish/images/brick.png
 - lib/rdoc/generator/template/darkfish/images/brick_link.png
@@ -394,7 +395,7 @@ post_install_message: |
 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/RI.txt

@@ -1,58 +0,0 @@
-= RI
-== Background
-+ri+ is a tool that allows Ruby documentation to be viewed on the command-line.
-It is part of RDoc and is expected to work on any platform supported by Ruby.
-
-+ri+ will be a bit slow the first time that it runs (or any time that the
-underlying documentation changes) because it builds a cache in the +.ri+
-directory within the user's home directory in order to make future accesses
-faster.
-
-== Usage
-To see information for a class, do:
-  ri class_name
-
-For example, for the +Array+ class, do
-  ri Array
-
-To see information for an instance method, do:
-  ri class_name#method_name
-
-For example, for Array's +join+ method, do:
-  ri Array#join
-
-To see information for a class method, do:
-  ri class_name.method_name
-
-For example, for Module's +private+ method, do:
-  ri Module.private
-
-To search for all methods containing +read+, do:
-  ri read
-
-To search for all methods starting with +read+, do:
-  ri '^read'
-
-To search for all +read+ methods, do:
-  ri '^read$'
-
-== Options
-+ri+ supports a variety of options, all of which can be viewed via +--help+.
-Of particular interest, are:
-[-d directory]
-  List of directories from which to source documentation in addition to
-  the standard directories.  May be repeated.  This can be used to specify
-  the location of site-specific documentation (which can be generated with
-  RDoc).
-[-i]
-  This makes +ri+ go into interactive mode.  When +ri+ is in interactive mode,
-  it will allow the user to disambiguate lists of methods in case multiple
-  methods match against a method search string.  It also will allow the user
-  to enter in a method name (with auto-completion, if readline is supported)
-  when viewing a class.
-[-T]
-  Send output to stdout, rather than to a pager.
-
-All options also can be specified through the +RI+ environment variable.
-Command-line options always override those specified in the +RI+ environment
-variable.

data/lib/rdoc/generator/template/darkfish/fileinfo.rhtml

@@ -1,32 +0,0 @@
-<body class="file file-popup">
-<nav id="metadata">
-  <dl>
-    <dt class="modified-date">Last Modified
-    <dd class="modified-date"><%= file.last_modified %>
-
-    <% if file.requires %>
-    <dt class="requires">Requires
-    <dd class="requires">
-      <ul>
-      <% file.requires.each do |require| %>
-        <li><%= require.name %>
-      <% end %>
-      </ul>
-    <% end %>
-
-    <% if @options.webcvs %>
-    <dt class="scs-url">Trac URL
-    <dd class="scs-url"><a target="_top"
-      href="<%= file.cvs_url %>"><%= file.cvs_url %></a>
-    <% end %>
-  </dl>
-</nav>
-
-<div id="documentation">
-  <% if file.comment %>
-  <div class="description">
-    <h2>Description</h2>
-    <%= file.description %>
-  </div>
-  <% end %>
-</div>